diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index f97008fef9..de5f0cb5fe 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -40,11 +40,6 @@ "redirect_url": "/powershell/azure/", "source_path": "docs-conceptual/azps-0.10.0/overview.md" }, - { - "redirect_document_id": false, - "redirect_url": "/powershell/azure/azurerm/overview", - "source_path": "docs-conceptual/azurermps-2.5.0/index.md" - }, { "redirect_document_id": false, "redirect_url": "/powershell/azure/azurerm/overview", diff --git a/azurermps-2.5.0/Azure.Storage/Azure.Storage.md b/azurermps-2.5.0/Azure.Storage/Azure.Storage.md deleted file mode 100644 index e22eaea1d4..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Azure.Storage.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -Module Name: Azure.Storage -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azure.storage -Help Version: 4.2.1.0 -Locale: en-US ---- - -# Azure.Storage Module -## Description -This topic displays help topics for the Azure Storage Cmdlets. - -## Azure.Storage Cmdlets -### [Disable-AzureStorageDeleteRetentionPolicy](Disable-AzureStorageDeleteRetentionPolicy.md) -Disable delete retention policy for the Azure Storage Blob service. - -### [Enable-AzureStorageDeleteRetentionPolicy](Enable-AzureStorageDeleteRetentionPolicy.md) -Enable delete retention policy for the Azure Storage Blob service. - -### [Get-AzureStorageBlob](Get-AzureStorageBlob.md) -Lists blobs in a container. - -### [Get-AzureStorageBlobContent](Get-AzureStorageBlobContent.md) -Downloads a storage blob. - -### [Get-AzureStorageBlobCopyState](Get-AzureStorageBlobCopyState.md) -Gets the copy status of an Azure Storage blob. - -### [Get-AzureStorageContainer](Get-AzureStorageContainer.md) -Lists the storage containers. - -### [Get-AzureStorageContainerStoredAccessPolicy](Get-AzureStorageContainerStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage container. - -### [Get-AzureStorageCORSRule](Get-AzureStorageCORSRule.md) -Gets CORS rules for a Storage service type. - -### [Get-AzureStorageFile](Get-AzureStorageFile.md) -Lists directories and files for a path. - -### [Get-AzureStorageFileContent](Get-AzureStorageFileContent.md) -Downloads the contents of a file. - -### [Get-AzureStorageFileCopyState](Get-AzureStorageFileCopyState.md) -Gets the state of a copy operation. - -### [Get-AzureStorageQueue](Get-AzureStorageQueue.md) -Lists storage queues. - -### [Get-AzureStorageQueueStoredAccessPolicy](Get-AzureStorageQueueStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage queue. - -### [Get-AzureStorageServiceLoggingProperty](Get-AzureStorageServiceLoggingProperty.md) -Gets logging properties for Azure Storage services. - -### [Get-AzureStorageServiceMetricsProperty](Get-AzureStorageServiceMetricsProperty.md) -Gets metrics properties for the Azure Storage service. - -### [Get-AzureStorageServiceProperty](Get-AzureStorageServiceProperty.md) -Gets properties for Azure Storage services. - -### [Get-AzureStorageShare](Get-AzureStorageShare.md) -Gets a list of file shares. - -### [Get-AzureStorageShareStoredAccessPolicy](Get-AzureStorageShareStoredAccessPolicy.md) -Gets stored access policies for a Storage share. - -### [Get-AzureStorageTable](Get-AzureStorageTable.md) -Lists the storage tables. - -### [Get-AzureStorageTableStoredAccessPolicy](Get-AzureStorageTableStoredAccessPolicy.md) -Gets the stored access policy or policies for an Azure storage table. - -### [New-AzureStorageAccountSASToken](New-AzureStorageAccountSASToken.md) -Creates an account-level SAS token. - -### [New-AzureStorageBlobSASToken](New-AzureStorageBlobSASToken.md) -Generates a SAS token for an Azure storage blob. - -### [New-AzureStorageContainer](New-AzureStorageContainer.md) -Creates an Azure storage container. - -### [New-AzureStorageContainerSASToken](New-AzureStorageContainerSASToken.md) -Generates an SAS token for an Azure storage container. - -### [New-AzureStorageContainerStoredAccessPolicy](New-AzureStorageContainerStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage container. - -### [New-AzureStorageContext](New-AzureStorageContext.md) -Creates an Azure Storage context. - -### [New-AzureStorageDirectory](New-AzureStorageDirectory.md) -Creates a directory. - -### [New-AzureStorageFileSASToken](New-AzureStorageFileSASToken.md) -Generates a shared access signature token for a Storage file. - -### [New-AzureStorageQueue](New-AzureStorageQueue.md) -Creates a storage queue. - -### [New-AzureStorageQueueSASToken](New-AzureStorageQueueSASToken.md) -Generates a shared access signature token for an Azure storage queue. - -### [New-AzureStorageQueueStoredAccessPolicy](New-AzureStorageQueueStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage queue. - -### [New-AzureStorageShare](New-AzureStorageShare.md) -Creates a file share. - -### [New-AzureStorageShareSASToken](New-AzureStorageShareSASToken.md) -Generate Shared Access Signature token for Azure Storage share. - -### [New-AzureStorageShareStoredAccessPolicy](New-AzureStorageShareStoredAccessPolicy.md) -Creates a stored access policy on a Storage share. - -### [New-AzureStorageTable](New-AzureStorageTable.md) -Creates a storage table. - -### [New-AzureStorageTableSASToken](New-AzureStorageTableSASToken.md) -Generates an SAS token for an Azure Storage table. - -### [New-AzureStorageTableStoredAccessPolicy](New-AzureStorageTableStoredAccessPolicy.md) -Creates a stored access policy for an Azure storage table. - -### [Remove-AzureStorageBlob](Remove-AzureStorageBlob.md) -Removes the specified storage blob. - -### [Remove-AzureStorageContainer](Remove-AzureStorageContainer.md) -Removes the specified storage container. - -### [Remove-AzureStorageContainerStoredAccessPolicy](Remove-AzureStorageContainerStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage container. - -### [Remove-AzureStorageCORSRule](Remove-AzureStorageCORSRule.md) -Removes CORS for a Storage service. - -### [Remove-AzureStorageDirectory](Remove-AzureStorageDirectory.md) -Deletes a directory. - -### [Remove-AzureStorageFile](Remove-AzureStorageFile.md) -Deletes a file. - -### [Remove-AzureStorageQueue](Remove-AzureStorageQueue.md) -Removes a storage queue. - -### [Remove-AzureStorageQueueStoredAccessPolicy](Remove-AzureStorageQueueStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage queue. - -### [Remove-AzureStorageShare](Remove-AzureStorageShare.md) -Deletes a file share. - -### [Remove-AzureStorageShareStoredAccessPolicy](Remove-AzureStorageShareStoredAccessPolicy.md) -Removes a stored access policy from a Storage share. - -### [Remove-AzureStorageTable](Remove-AzureStorageTable.md) -Removes a storage table. - -### [Remove-AzureStorageTableStoredAccessPolicy](Remove-AzureStorageTableStoredAccessPolicy.md) -Removes a stored access policy from an Azure storage table. - -### [Set-AzureStorageBlobContent](Set-AzureStorageBlobContent.md) -Uploads a local file to an Azure Storage blob. - -### [Set-AzureStorageContainerAcl](Set-AzureStorageContainerAcl.md) -Sets the public access permission to a storage container. - -### [Set-AzureStorageContainerStoredAccessPolicy](Set-AzureStorageContainerStoredAccessPolicy.md) -Sets a stored access policy for an Azure storage container. - -### [Set-AzureStorageCORSRule](Set-AzureStorageCORSRule.md) -Sets the CORS rules for a type of Storage service. - -### [Set-AzureStorageFileContent](Set-AzureStorageFileContent.md) -Uploads the contents of a file. - -### [Set-AzureStorageQueueStoredAccessPolicy](Set-AzureStorageQueueStoredAccessPolicy.md) -Sets a stored access policy for an Azure storage queue. - -### [Set-AzureStorageServiceLoggingProperty](Set-AzureStorageServiceLoggingProperty.md) -Modifies logging for Azure Storage services. - -### [Set-AzureStorageServiceMetricsProperty](Set-AzureStorageServiceMetricsProperty.md) -Modifies metrics properties for the Azure Storage service. - -### [Set-AzureStorageShareQuota](Set-AzureStorageShareQuota.md) -Sets the storage capacity for a share. - -### [Set-AzureStorageShareStoredAccessPolicy](Set-AzureStorageShareStoredAccessPolicy.md) -Updates a stored access policy on a Storage share. - -### [Set-AzureStorageTableStoredAccessPolicy](Set-AzureStorageTableStoredAccessPolicy.md) -Sets the stored access policy for an Azure storage table. - -### [Start-AzureStorageBlobCopy](Start-AzureStorageBlobCopy.md) -Starts to copy a blob. - -### [Start-AzureStorageBlobIncrementalCopy](Start-AzureStorageBlobIncrementalCopy.md) -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. - -### [Start-AzureStorageFileCopy](Start-AzureStorageFileCopy.md) -Starts to copy a source file. - -### [Stop-AzureStorageBlobCopy](Stop-AzureStorageBlobCopy.md) -Stops a copy operation. - -### [Stop-AzureStorageFileCopy](Stop-AzureStorageFileCopy.md) -Stops a copy operation to the specified destination file. - -### [Update-AzureStorageServiceProperty](Update-AzureStorageServiceProperty.md) -Modifies the properties for the Azure Storage service. - diff --git a/azurermps-2.5.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md b/azurermps-2.5.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md deleted file mode 100644 index 88236858e9..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Disable-AzureStorageDeleteRetentionPolicy.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/disable-azurestoragedeleteretentionpolicy -schema: 2.0.0 ---- - -# Disable-AzureStorageDeleteRetentionPolicy - -## SYNOPSIS -Disable delete retention policy for the Azure Storage Blob service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureStorageDeleteRetentionPolicy [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-AzureStorageDeleteRetentionPolicy** cmdlet disables delete retention policy for the Azure Storage Blob service. - -## EXAMPLES - -### Example 1: Disable delete retention policy for the Blob service -``` -C:\PS>Disable-AzureStorageDeleteRetentionPolicy -``` - -This command disables delete retention policy for the Blob service. - -## PARAMETERS - -### -Context -Azure Storage Context Object - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display DeleteRetentionPolicyProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md b/azurermps-2.5.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md deleted file mode 100644 index c22c44e5c4..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Enable-AzureStorageDeleteRetentionPolicy.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/enable-azurestoragedeleteretentionpolicy -schema: 2.0.0 ---- - -# Enable-AzureStorageDeleteRetentionPolicy - -## SYNOPSIS -Enable delete retention policy for the Azure Storage Blob service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Enable-AzureStorageDeleteRetentionPolicy [-RetentionDays] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-AzureStorageDeleteRetentionPolicy** cmdlet enables delete retention policy for the Azure Storage Blob service. - -## EXAMPLES - -### Example 1: Enable delete retention policy for the Blob service -``` -C:\PS>Enable-AzureStorageDeleteRetentionPolicy -RetentionDays 3 -``` - -This command enables delete retention policy for the Blob service, and set deleted blob retention days to 3. - -## PARAMETERS - -### -Context -Azure Storage Context Object - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display DeleteRetentionPolicyProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Sets the number of retention days for the DeleteRetentionPolicy. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: Days - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSDeleteRetentionPolicy - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlob.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlob.md deleted file mode 100644 index f132bc32cb..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlob.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E54BFD3A-CD54-4E6B-9574-92B8D3E88FF3 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblob -schema: 2.0.0 ---- - -# Get-AzureStorageBlob - -## SYNOPSIS -Lists blobs in a container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BlobName (Default) -``` -Get-AzureStorageBlob [[-Blob] ] [-Container] [-IncludeDeleted] [-MaxCount ] - [-ContinuationToken ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### BlobPrefix -``` -Get-AzureStorageBlob [-Prefix ] [-Container] [-IncludeDeleted] [-MaxCount ] - [-ContinuationToken ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlob** cmdlet lists blobs in the specified container in an Azure storage account. - -## EXAMPLES - -### Example 1: Get a blob by blob name -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Blob blob* -``` - -This command uses a blob name and wildcard to get a blob. - -### Example 2: Get blobs in a container by using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Name container* | Get-AzureStorageBlob -IncludeDeleted - - Container Uri: https://storageaccountname.blob.core.windows.net/container1 - -Name BlobType Length ContentType LastModified AccessTier SnapshotTime IsDeleted ----- -------- ------ ----------- ------------ ---------- ------------ --------- -test1 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:19Z 2017-11-08 08:19:32Z True -test1 BlockBlob 403116 application/octet-stream 2017-11-08 09:00:29Z True -test2 BlockBlob 403116 application/octet-stream 2017-11-08 07:53:00Z False -``` - -This command uses the pipeline to get all blobs (include blobs in Deleted status) in a container. - -### Example 3: Get blobs by name prefix -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Prefix "blob" -``` - -This command uses a name prefix to get blobs. - -### Example 4: List blobs in multiple batches -``` -PS C:\>$MaxReturn = 10000 -PS C:\> $ContainerName = "abc" -PS C:\> $Total = 0 -PS C:\> $Token = $Null -PS C:\> do - { - $Blobs = Get-AzureStorageBlob -Container $ContainerName -MaxCount $MaxReturn -ContinuationToken $Token - $Total += $Blobs.Count - if($Blobs.Length -le 0) { Break;} - $Token = $Blobs[$blobs.Count -1].ContinuationToken; - } - While ($Token -ne $Null) -PS C:\> Echo "Total $Total blobs in container $ContainerName" -``` - -This example uses the *MaxCount* and *ContinuationToken* parameters to list Azure Storage blobs in multiple batches. -The first four commands assign values to variables to use in the example. -The fifth command specifies a **Do-While** statement that uses the **Get-AzureStorageBlob** cmdlet to get blobs. -The statement includes the continuation token stored in the $Token variable. -$Token changes value as the loop runs. -For more information, type `Get-Help About_Do`. -The final command uses the **Echo** command to display the total. - -## PARAMETERS - -### -Blob -Specifies a name or name pattern, which can be used for a wildcard search. -If no blob name is specified, the cmdlet lists all the blobs in the specified container. -If a value is specified for this parameter, the cmdlet lists all blobs with names that match this parameter. - -```yaml -Type: System.String -Parameter Sets: BlobName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage account from which you want to get a list of blobs. -You can use the New-AzureStorageContext cmdlet to create a storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies a continuation token for the blob list. -Use this parameter and the *MaxCount* parameter to list blobs in multiple batches. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContinuationToken -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDeleted -Include Deleted Blob, by default get blob won't include deleted blob. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of objects that this cmdlet returns. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix for the blob names that you want to get. -This parameter does not support using regular expressions or wildcard characters to search. -This means that if the container has only blobs named "My", "MyBlob1", and "MyBlob2" and you specify "-Prefix My*", the cmdlet returns no blobs. -However, if you specify "-Prefix My", the cmdlet returns "My", "MyBlob1", and "MyBlob2". - -```yaml -Type: System.String -Parameter Sets: BlobPrefix -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobContent.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobContent.md deleted file mode 100644 index 34413aad18..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobContent.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C091D654-E113-4AE0-A6C8-24630D1294A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblobcontent -schema: 2.0.0 ---- - -# Get-AzureStorageBlobContent - -## SYNOPSIS -Downloads a storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ReceiveManual (Default) -``` -Get-AzureStorageBlobContent [-Blob] [-Container] [-Destination ] [-CheckMd5] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Get-AzureStorageBlobContent -CloudBlob [-Destination ] [-CheckMd5] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Get-AzureStorageBlobContent -CloudBlobContainer [-Blob] [-Destination ] - [-CheckMd5] [-Force] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlobContent** cmdlet downloads the specified storage blob. -If the blob name is not valid for the local computer, this cmdlet automatically resolves it if it is possible. - -## EXAMPLES - -### Example 1: Download blob content by name -``` -PS C:\>Get-AzureStorageBlobContent -Container "ContainerName" -Blob "Blob" -Destination "C:\test\" -``` - -This command downloads a blob by name. - -### Example 2: Download blob content using the pipeline -``` -PS C:\>Get-AzureStorageBlob -Container containername -Blob blobname | Get-AzureStorageBlobContent -``` - -This command uses the pipeline to find and download blob content. - -### Example 3: Download blob content using the pipeline and a wildcard character -``` -PS C:\>Get-AzureStorageContainer container* | Get-AzureStorageBlobContent -Blob "cbox.exe" -Destination "C:\test" -``` - -This example uses the asterisk wildcard character and the pipeline to find and download blob content. - -## PARAMETERS - -### -Blob -Specifies the name of the blob to be downloaded. - -```yaml -Type: System.String -Parameter Sets: ReceiveManual, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CheckMd5 -Specifies whether to check the Md5 sum for the downloaded file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a cloud blob. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure storage client library. -You can create it or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of container that has the blob you want to download. - -```yaml -Type: System.String -Parameter Sets: ReceiveManual -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage account from which you want to download blob content. -You can use the New-AzureStorageContext cmdlet to create a storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the location to store the downloaded file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Path - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overwrites an existing file without confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES -* If the blob name is invalid for local computer, this cmdlet autoresolves it, if it is possible. - -## RELATED LINKS - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobCopyState.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobCopyState.md deleted file mode 100644 index 65b08ba412..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageBlobCopyState.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: CBD157D2-37C5-491F-A806-6B39F1D0415A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageblobcopystate -schema: 2.0.0 ---- - -# Get-AzureStorageBlobCopyState - -## SYNOPSIS -Gets the copy status of an Azure Storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Get-AzureStorageBlobCopyState [-Blob] [-Container] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### BlobPipeline -``` -Get-AzureStorageBlobCopyState -CloudBlob [-WaitForComplete] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### ContainerPipeline -``` -Get-AzureStorageBlobCopyState -CloudBlobContainer [-Blob] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageBlobCopyState** cmdlet gets the copy status of an Azure Storage blob. - -## EXAMPLES - -### Example 1: Get the copy status of a blob -``` -C:\PS>Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -Container "ContosoUploads" -``` - -This command gets the copy status of the blob named ContosoPlanning2015 in the container ContosoUploads. - -### Example 2: Get the copy status for of a blob by using the pipeline -``` -C:\PS>Get-AzureStorageBlob -Blob "ContosoPlanning2015" -Container "ContosoUploads" | Get-AzureStorageBlobCopyState -``` - -This command gets the blob named ContosoPlanning2015 in the container named ContosoUploads by using the **Get-AzureStorageBlob** cmdlet, and then passes the result to the current cmdlet by using the pipeline operator. -The **Get-AzureStorageBlobCopyState** cmdlet gets the copy status for that blob. - -### Example 3: Get the copy status for a blob in a container by using the pipeline -``` -C:\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Get-AzureStorageBlobCopyState -Blob "ContosoPlanning2015" -``` - -This command gets the container named by using the **Get-AzureStorageBlob** cmdlet, and then passes the result to the current cmdlet. -The **Get-AzureStorageContainer** cmdlet gets the copy status for the blob named ContosoPlanning2015 in that container. - -## PARAMETERS - -### -Blob -Specifies the name of a blob. -This cmdlet gets the state of the blob copy operation for the Azure Storage blob that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet gets the copy status of a blob in the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of a container. -This cmdlet gets the copy status for a blob in the container that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForComplete -Indicates that this cmdlet waits for the copy to finish. -If you do not specify this parameter, this cmdlet returns a result immediately. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Start-AzureStorageBlobCopy](./Start-AzureStorageBlobCopy.md) - -[Stop-AzureStorageBlobCopy](./Stop-AzureStorageBlobCopy.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageCORSRule.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageCORSRule.md deleted file mode 100644 index 942c66a9f0..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageCORSRule.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5FA8A3F3-F52C-40BC-94C2-4CDA00C6F32F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecorsrule -schema: 2.0.0 ---- - -# Get-AzureStorageCORSRule - -## SYNOPSIS -Gets CORS rules for a Storage service type. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageCORSRule [-ServiceType] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageCORSRule** cmdlet gets Cross-Origin Resource Sharing (CORS) rules for an Azure Storage service type. - -## EXAMPLES - -### Example 1: Get CORS rules of blob service -``` -PS C:\>Get-AzureStorageCORSRule -ServiceType Blob -``` - -This command gets the CORS rules for the Blob service type. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet gets CORS rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule - -## NOTES - -## RELATED LINKS - -[Remove-AzureStorageCORSRule](./Remove-AzureStorageCORSRule.md) - -[Set-AzureStorageCORSRule](./Set-AzureStorageCORSRule.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainer.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainer.md deleted file mode 100644 index cbd6a9e3fd..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainer.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 90C3DF13-0010-49B6-A8CD-C6AC34BC3EFA -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecontainer -schema: 2.0.0 ---- - -# Get-AzureStorageContainer - -## SYNOPSIS -Lists the storage containers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName (Default) -``` -Get-AzureStorageContainer [[-Name] ] [-MaxCount ] [-ContinuationToken ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### ContainerPrefix -``` -Get-AzureStorageContainer -Prefix [-MaxCount ] [-ContinuationToken ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageContainer** cmdlet lists the storage containers associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: Get Azure Storage blob by name -``` -PS C:\>Get-AzureStorageContainer -Name container* -``` - -This example uses a wildcard character to return a list of all containers with a name that starts with container. - -### Example 2: Get Azure Storage container by container name prefix -``` -PS C:\>Get-AzureStorageContainer -Prefix "container" -``` - -This example uses the *Prefix* parameter to return a list of all containers with a name that starts with container. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. -The cmdlet will fail when you use a storage context created from SAS Token because the cmdlet will query for container permissions which require Storage account key permission. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies a continuation token for the blob list. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContinuationToken -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCount -Specifies the maximum number of objects that this cmdlet returns. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the container name. -If container name is empty, the cmdlet lists all the containers. -Otherwise, it lists all containers that match the specified name or the regular name pattern. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: N, Container - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the container or containers you want to get. -You can use this to find all containers that start with the same string, such as "my" or "test". - -```yaml -Type: System.String -Parameter Sets: ContainerPrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - -[Set-AzureStorageContainerAcl](./Set-AzureStorageContainerAcl.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 5929004ea8..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 10D5B7E0-242B-4DC0-A527-8F6388E72E0A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 ---- - -# Get-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageContainerStoredAccessPolicy [-Container] [[-Policy] ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageContainerStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage container. - -## EXAMPLES - -### Example 1: Get a stored access policy in a storage container -``` -PS C:\>Get-AzureStorageContainerStoredAccessPolicy -Container "Container07" -Policy "Policy22" -``` - -This command gets the access policy named Policy22 in the storage container named Container07. - -### Example 2: Get all the stored access policies in a storage container -``` -PS C:\>Get-AzureStorageContainerStoredAccessPolicy -Container "Container07" -``` - -This command gets all access policies in the storage container named Container07. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of your Azure storage container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the Azure stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Blob.SharedAccessBlobPolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFile.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFile.md deleted file mode 100644 index 518eb3dfb7..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFile.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 38207027-FD76-45EE-8817-88599735C0B0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefile -schema: 2.0.0 ---- - -# Get-AzureStorageFile - -## SYNOPSIS -Lists directories and files for a path. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Get-AzureStorageFile [-ShareName] [[-Path] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -Get-AzureStorageFile [-Share] [[-Path] ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Directory -``` -Get-AzureStorageFile [-Directory] [[-Path] ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFile** cmdlet lists directories and files for the share or directory that you specify. -Specify the *Path* parameter to get an instance of a directory or file in the specified path. -This cmdlet returns **AzureStorageFile** and **AzureStorageDirectory** objects. -You can use the **IsDirectory** property to distinguish between folders and files. - -## EXAMPLES - -### Example 1: List directories in a share -``` -PS C:\>Get-AzureStorageFile -ShareName "ContosoShare06" | where {$_.GetType().Name -eq "CloudFileDirectory"} -``` - -This command lists only the directories in the share ContosoShare06. -It first retrieves both files and directories, passes them to the **where** operator by using the pipeline operator, then discards any objects whose type is not "CloudFileDirectory". - -### Example 2: List a File Directory -``` -PS C:\> Get-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" | Get-AzureStorageFile -``` - -This command lists the files and folders in the directory ContosoWorkingFolder under the share ContosoShare06. -It first gets the directory instance, and then pipelines it to the **Get-AzureStorageFile** cmdlet to list the directory. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client side time-out interval, in seconds, for one service request. -If the previous call fails within the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help mitigate network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a Storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet gets the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the **Get-AzureStorageFile** cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -If you omit the *Path* parameter, **Get-AzureStorageFile** lists the directories and files in the specified file share or directory. -If you include the *Path* parameter, **Get-AzureStorageFile** returns an instance of a directory or file in the specified path. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service-side timeout interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the Storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet gets a file or directory from the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the Storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet gets a file or directory from the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) - -[Remove-AzureStorageFile](./Remove-AzureStorageFile.md) - -[Set-AzureStorageFileContent](./Set-AzureStorageFileContent.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileContent.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileContent.md deleted file mode 100644 index fed63639bc..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileContent.md +++ /dev/null @@ -1,379 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6420CBE1-BF9D-493D-BCA8-E8C6688FAF3B -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefilecontent -schema: 2.0.0 ---- - -# Get-AzureStorageFileContent - -## SYNOPSIS -Downloads the contents of a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Get-AzureStorageFileContent [-ShareName] [-Path] [[-Destination] ] [-CheckMd5] - [-PassThru] [-Force] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### Share -``` -Get-AzureStorageFileContent [-Share] [-Path] [[-Destination] ] [-CheckMd5] - [-PassThru] [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Get-AzureStorageFileContent [-Directory] [-Path] [[-Destination] ] - [-CheckMd5] [-PassThru] [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Get-AzureStorageFileContent [-File] [[-Destination] ] [-CheckMd5] [-PassThru] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFileContent** cmdlet downloads the contents of a file, and then saves it to a destination that you specify. -This cmdlet does not return the contents of the file. - -## EXAMPLES - -### Example 1: Download a file from a folder -``` -PS C:\>Get-AzureStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWorkingFolder/CurrentDataFile" -``` - -This command downloads a file that is named CurrentDataFile in the folder ContosoWorkingFolder from the file share ContosoShare06 to current folder. - -### Example 2: Downloads the files under sample file share -``` -PS C:\>Get-AzureStorageFile -ShareName sample | ? {$_.GetType().Name -eq "CloudFile"} | Get-AzureStorageFileContent -``` - -This example downloads the files under sample file share - -## PARAMETERS - -### -CheckMd5 -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the destination path. -This cmdlet downloads the file contents to the location that this parameter specifies. -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet gets content for a file in the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -File -Specifies a file as a **CloudFile** object. -This cmdlet gets the file that this parameter specifies. -To obtain a **CloudFile** object, use the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file. -This cmdlet gets the contents the file that this parameter specifies. -If the file does not exist, this cmdlet returns an error. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share, Directory -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file. -If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file. -If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues. -If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet downloads the contents of the file in the share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet downloads the contents of the file in the share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Set-AzureStorageFileContent](./Set-AzureStorageFileContent.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileCopyState.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileCopyState.md deleted file mode 100644 index 7115ac0f4b..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageFileCopyState.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C1648DC3-8CFD-4487-A080-D9BE25DAD258 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragefilecopystate -schema: 2.0.0 ---- - -# Get-AzureStorageFileCopyState - -## SYNOPSIS -Gets the state of a copy operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Get-AzureStorageFileCopyState [-ShareName] [-FilePath] [-WaitForComplete] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### File -``` -Get-AzureStorageFileCopyState [-File] [-WaitForComplete] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageFileCopyState** cmdlet gets the state of an Azure Storage file copy operation. - -## EXAMPLES - -### Example 1: Get the copy state by file name -``` -PS C:\>Get-AzureStorageFileCopyState -ShareName "ContosoShare" -FilePath "ContosoFile" -``` - -This command gets the state of the copy operation for a file that has the specified name. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of the file relative to an Azure Storage share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of a share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForComplete -Indicates that this cmdlet waits for the copy to finish. -If you do not specify this parameter, this cmdlet returns a result immediately. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Start-AzureStorageFileCopy](./Start-AzureStorageFileCopy.md) - -[Stop-AzureStorageFileCopy](./Stop-AzureStorageFileCopy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueue.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueue.md deleted file mode 100644 index 63f47e9845..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueue.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C2EBCCF0-56CE-4D49-A138-74E52FC3A9AC -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragequeue -schema: 2.0.0 ---- - -# Get-AzureStorageQueue - -## SYNOPSIS -Lists storage queues. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### QueueName (Default) -``` -Get-AzureStorageQueue [[-Name] ] [-Context ] - [-DefaultProfile ] [] -``` - -### QueuePrefix -``` -Get-AzureStorageQueue -Prefix [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageQueue** cmdlet lists storage queues associated with an Azure Storage account. - -## EXAMPLES - -### Example 1: List all Azure Storage queues -``` -PS C:\>Get-AzureStorageQueue -``` - -This command gets a list of all storage queues for the current Storage account. - -### Example 2: List Azure Storage queues using a wildcard character -``` -PS C:\>Get-AzureStorageQueue -Name queue* -``` - -This command uses a wildcard character to get a list of storage queues whose name starts with queue. - -### Example 3: List Azure Storage queues using queue name prefix -``` -PS C:\>Get-AzureStorageQueue -Prefix "queue" -``` - -This example uses the *Prefix* parameter to get a list of storage queues whose name starts with queue. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the **New-AzureStorageContext** cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name. -If no name is specified, the cmdlet gets a list of all the queues. -If a full or partial name is specified, the cmdlet gets all queues that match the name pattern. - -```yaml -Type: System.String -Parameter Sets: QueueName -Aliases: N, Queue - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the queues you want to get. - -```yaml -Type: System.String -Parameter Sets: QueuePrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue - -## NOTES - -## RELATED LINKS - -[New-AzureStorageQueue](./New-AzureStorageQueue.md) - -[Remove-AzureStorageQueue](./Remove-AzureStorageQueue.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index be2b01f97e..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: F1EC601C-3ADD-402A-A5F7-84A95D312187 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 ---- - -# Get-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageQueueStoredAccessPolicy [-Queue] [[-Policy] ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageQueueStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage queue. - -## EXAMPLES - -### Example 1: Get a stored access policy in the queue -``` -PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy12" -``` - -This command gets the access policy named Policy12 in the storage queue named MyQueue. - -### Example 2: Get all stored access policies in the queue -``` -PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -``` - -This command gets all stored access policies in the queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Queue.SharedAccessQueuePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md deleted file mode 100644 index 96fd6aff18..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceLoggingProperty.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 494291A1-D854-4E97-B5EE-27BB5653D97C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageserviceloggingproperty -schema: 2.0.0 ---- - -# Get-AzureStorageServiceLoggingProperty - -## SYNOPSIS -Gets logging properties for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceLoggingProperty [-ServiceType] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceLoggingProperty** cmdlet gets logging properties for Azure Storage services. - -## EXAMPLES - -### Example 1: Get logging properties for the Blob service -``` -C:\PS>Get-AzureStorageServiceLoggingProperty -ServiceType Blob -``` - -This command gets logging properties for blob storage. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingProperties - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageServiceLoggingProperty](./Set-AzureStorageServiceLoggingProperty.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md deleted file mode 100644 index 15c52ba26c..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceMetricsProperty.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3B5B828A-6B3E-49BD-8BA9-916F8B69B8E9 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageservicemetricsproperty -schema: 2.0.0 ---- - -# Get-AzureStorageServiceMetricsProperty - -## SYNOPSIS -Gets metrics properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceMetricsProperty [-ServiceType] [-MetricsType] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceMetricsProperty** cmdlet gets metrics properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Get metrics properties for the Blob service -``` -C:\PS>Get-AzureStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -``` - -This command gets metrics properties for blob storage for the Hour metrics type. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsType -Specifies a metrics type. -This cmdlet gets the Azure Storage service metrics properties for the metrics type that this parameter specifies. -The acceptable values for this parameter are: Hour and Minute. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Minute - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the metrics properties for the type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageServiceMetricsProperty](./Set-AzureStorageServiceMetricsProperty.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceProperty.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceProperty.md deleted file mode 100644 index 0fa7bd68c4..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageServiceProperty.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageserviceproperty -schema: 2.0.0 ---- - -# Get-AzureStorageServiceProperty - -## SYNOPSIS -Gets properties for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageServiceProperty [-ServiceType] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageServiceProperty** cmdlet gets the properties for Azure Storage services. - -## EXAMPLES - -### Example 1: Get Azure Storage services property of the Blob service -``` -C:\PS>Get-AzureStorageServiceProperty -ServiceType Blob - -Logging.Version : 1.0 -Logging.LoggingOperations : None -Logging.RetentionDays : -HourMetrics.Version : 1.0 -HourMetrics.MetricsLevel : ServiceAndApi -HourMetrics.RetentionDays : 7 -MinuteMetrics.Version : 1.0 -MinuteMetrics.MetricsLevel : None -MinuteMetrics.RetentionDays : -DeleteRetentionPolicy.Enabled : True -DeleteRetentionPolicy.RetentionDays : 70 -Cors : -DefaultServiceVersion : 2017-07-29 -``` - -This command gets DefaultServiceVersion property of the Blob service. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShare.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShare.md deleted file mode 100644 index bb871f62bc..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShare.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FD3A0013-4365-4E65-891C-5C50A9D5658C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestorageshare -schema: 2.0.0 ---- - -# Get-AzureStorageShare - -## SYNOPSIS -Gets a list of file shares. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MatchingPrefix (Default) -``` -Get-AzureStorageShare [[-Prefix] ] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Specific -``` -Get-AzureStorageShare [-Name] [[-SnapshotTime] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageShare** cmdlet gets a list of file shares for a storage account. - -## EXAMPLES - -### Example 1: Get a file share -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" -``` - -This command gets the file share named ContosoShare06. - -### Example 2: Get all file shares that begin with a string -``` -PS C:\>Get-AzureStorageShare -Prefix "Contoso" -``` - -This command gets all file shares that have names that begin with Contoso. - -### Example 3: Get all file shares in a specified context -``` -PS C:\>$Context = New-AzureStorageContext -Local -PS C:\> Get-AzureStorageShare -Context $Context -``` - -The first command uses the **New-AzureStorageContext** cmdlet to create a context by using the *Local* parameter, and then stores that context object in the $Context variable. -The second command gets the file shares for the context object stored in $Context. - -### Example 4: Get a file share snapshot with specific share name and SnapshotTime -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" -SnapshotTime "6/16/2017 9:48:41 AM +00:00" -``` - -This command gets a file share snapshot with specific share name and SnapshotTime. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 file share. -This cmdlet gets the file share that this parameter specifies, or nothing if you specify the name of a file share that does not exist. - -```yaml -Type: System.String -Parameter Sets: Specific -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the prefix for file shares. -This cmdlet gets file shares that match the prefix that this parameter specifies, or no file shares if no file shares match the specified prefix. - -```yaml -Type: System.String -Parameter Sets: MatchingPrefix -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotTime -SnapshotTime of the file share snapshot to be received. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: Specific -Aliases: - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[New-AzureStorageShare](./New-AzureStorageShare.md) - -[Remove-AzureStorageShare](./Remove-AzureStorageShare.md) diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 653be80325..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 73BB521B-20F2-4F2B-AA88-2B128F36A9EF -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragesharestoredaccesspolicy -schema: 2.0.0 ---- - -# Get-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Gets stored access policies for a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageShareStoredAccessPolicy [-ShareName] [[-Policy] ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageShareStoredAccessPolicy** cmdlet gets stored access policies for an Azure Storage share. -To get a particular policy, specify it by name. - -## EXAMPLES - -### Example 1: Get a stored access policy in a share -``` -PS C:\>Get-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -``` - -This command gets a stored access policy named GeneralPolicy in ContosoShare. - -### Example 2: Get all the stored access policies in share -``` -PS C:\>Get-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -``` - -This command gets all stored access policies in ContosoShare. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the Storage share name for which this cmdlet gets policies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.SharedAccessFilePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTable.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTable.md deleted file mode 100644 index 6b94161f8a..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTable.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 4631D36F-926A-4279-AA4D-5F694C18081E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragetable -schema: 2.0.0 ---- - -# Get-AzureStorageTable - -## SYNOPSIS -Lists the storage tables. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TableName (Default) -``` -Get-AzureStorageTable [[-Name] ] [-Context ] - [-DefaultProfile ] [] -``` - -### TablePrefix -``` -Get-AzureStorageTable -Prefix [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **Get-AzureStorageTable** cmdlet lists the storage tables associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: List all Azure Storage tables -``` -PS C:\>Get-AzureStorageTable -``` - -This command gets all storage tables for a Storage account. - -### Example 2: List Azure Storage tables using a wildcard character -``` -PS C:\>Get-AzureStorageTable -Name table* -``` - -This command uses a wildcard character to get storage tables whose name starts with table. - -### Example 3: List Azure Storage tables using table name prefix -``` -PS C:\>Get-AzureStorageTable -Prefix "table" -``` - -This command uses the *Prefix* parameter to get storage tables whose name starts with table. - -## PARAMETERS - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 table name. -If the table name is empty, the cmdlet lists all the tables. -Otherwise, it lists all tables that match the specified name or the regular name pattern. - -```yaml -Type: System.String -Parameter Sets: TableName -Aliases: N, Table - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Prefix -Specifies a prefix used in the name of the table or tables you want to get. -You can use this to find all tables that start with the same string, such as table. - -```yaml -Type: System.String -Parameter Sets: TablePrefix -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable - -## NOTES - -## RELATED LINKS - -[New-AzureStorageTable](./New-AzureStorageTable.md) - -[Remove-AzureStorageTable](./Remove-AzureStorageTable.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 8b361be60a..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Get-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BF5526C1-11B9-47A8-A5A6-CB275B470A9E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/get-azurestoragetablestoredaccesspolicy -schema: 2.0.0 ---- - -# Get-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Gets the stored access policy or policies for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureStorageTableStoredAccessPolicy [-Table] [[-Policy] ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Get-AzureStorageTableStoredAccessPolicy** cmdlet lists the stored access policy or policies for an Azure storage table. - -## EXAMPLES - -### Example 1: Get a stored access policy in a storage table -``` -PS C:\>Get-AzureStorageTableStoredAccessPolicy -Table "Table02" -Policy "Policy50" -``` - -This command gets the access policy named Policy50 in the storage table named Table02. - -### Example 2: Get all stored access policies in a storage table -``` -PS C:\>Get-AzureStorageTableStoredAccessPolicy -Table "Table02" -``` - -This command gets all access policies in the table named Table02. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Table.SharedAccessTablePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageAccountSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageAccountSASToken.md deleted file mode 100644 index e82a520812..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageAccountSASToken.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BCCBB05B-A5D7-4796-BE55-6BE5E18E07FC -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageaccountsastoken -schema: 2.0.0 ---- - -# New-AzureStorageAccountSASToken - -## SYNOPSIS -Creates an account-level SAS token. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageAccountSASToken -Service - -ResourceType [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageSASToken** cmdlet creates an account-level shared access signature (SAS) token for an Azure Storage account. -You can use the SAS token to delegate permissions for multiple services, or to delegate permissions for services not available with an object-level SAS token. - -## EXAMPLES - -### Example 1: Create an account-level SAS token with full permission -``` -PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -``` - -This command creates an account-level SAS token with full permission. - -### Example 2: Create an account-level SAS token for a range of IP addresses -``` -PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -IPAddressOrRange 168.1.5.60-168.1.5.70 -``` - -This command creates an account-level SAS token for HTTPS-only requests from the specified range of IP addresses. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can use the New-AzureStorageContext cmdlet to get an **AzureStorageContext** object. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for Storage account. -Permissions are valid only if they match the specified resource type. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). -For more information about acceptable permission values, see Constructing an Account SAS https://go.microsoft.com/fwlink/?LinkId=799514 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request made with the account SAS. -The acceptable values for this parameter are: -- HttpsOnly -- HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource types that are available with the SAS token. -The acceptable values for this parameter are: -- None -- Service -- Container -- Object - -```yaml -Type: Microsoft.WindowsAzure.Storage.SharedAccessAccountResourceTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, Service, Container, Object - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Specifies the service. -The acceptable values for this parameter are: -- None -- Blob -- File -- Queue -- Table - -```yaml -Type: Microsoft.WindowsAzure.Storage.SharedAccessAccountServices -Parameter Sets: (All) -Aliases: -Accepted values: None, Blob, File, Queue, Table - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time, as a **DateTime** object, at which the SAS becomes valid. -To get a **DateTime** object, use the Get-Date cmdlet. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageBlobSASToken](./New-AzureStorageBlobSASToken.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) - -[New-AzureStorageFileSASToken](./New-AzureStorageFileSASToken.md) - -[New-AzureStorageQueueSASToken](./New-AzureStorageQueueSASToken.md) - -[New-AzureStorageShareSASToken](./New-AzureStorageShareSASToken.md) - -[New-AzureStorageTableSASToken](./New-AzureStorageTableSASToken.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageBlobSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageBlobSASToken.md deleted file mode 100644 index d7e0185b78..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageBlobSASToken.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 585371E3-D4CE-452E-B0B0-92B3ABD127E7 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageblobsastoken -schema: 2.0.0 ---- - -# New-AzureStorageBlobSASToken - -## SYNOPSIS -Generates a SAS token for an Azure storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BlobNameWithPermission (Default) -``` -New-AzureStorageBlobSASToken [-Container] [-Blob] [-Permission ] - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### BlobPipelineWithPolicy -``` -New-AzureStorageBlobSASToken -CloudBlob -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### BlobPipelineWithPermission -``` -New-AzureStorageBlobSASToken -CloudBlob [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### BlobNameWithPolicy -``` -New-AzureStorageBlobSASToken [-Container] [-Blob] -Policy - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageBlobSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage blob. - -## EXAMPLES - -### Example 1: Generate a blob SAS token with full blob permission -``` -PS C:\>New-AzureStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -``` - -This example generates a blob SAS token with full blob permission. - -### Example 2: Generate a blob SAS token with life time -``` -PS C:\> $StartTime = Get-Date -PS C:\> $EndTime = $startTime.AddHours(2.0) -PS C:\> New-AzureStorageBlobSASToken -Container "ContainerName" -Blob "BlobName" -Permission rwd -StartTime $StartTime -ExpiryTime $EndTime -``` - -This example generates a blob SAS token with life time. - -## PARAMETERS - -### -Blob -Specifies the storage blob name. - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies the **CloudBlob** object. -To obtain a **CloudBlob** object, use the [Get-AzureStorageBlob](./Get-AzureStorageBlob.md) cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipelineWithPolicy, BlobPipelineWithPermission -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Container -Specifies the storage container name. - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobNameWithPolicy -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the storage context. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the shared access signature expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for a storage blob. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: BlobNameWithPermission, BlobPipelineWithPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure Stored Access Policy. - -```yaml -Type: System.String -Parameter Sets: BlobPipelineWithPolicy, BlobNameWithPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainer.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainer.md deleted file mode 100644 index 012a4ee729..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainer.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 2B12BC19-EF8F-43F5-AF04-C570FEEA1AE6 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainer -schema: 2.0.0 ---- - -# New-AzureStorageContainer - -## SYNOPSIS -Creates an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageContainer [-Name] [[-Permission] ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainer** cmdlet creates an Azure storage container. - -## EXAMPLES - -### Example 1: Create an Azure storage container -``` -PS C:\>New-AzureStorageContainer -Name "ContainerName" -Permission Off -``` - -This command creates a storage container. - -### Example 2: Create multiple Azure storage containers -``` -PS C:\>"container1 container2 container3".split() | New-AzureStorageContainer -Permission Container -``` - -This example creates multiple storage containers. -It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies a context for the new container. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new container. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies the level of public access to this container. -By default, the container and any blobs in it can be accessed only by the owner of the storage account. -To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. -Anonymous users can read blobs in a publicly available container without authenticating the request. -The acceptable values for this parameter are: -- Container. -Provides full read access to a container and its blobs. -Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. -- Blob. -Provides read access to blob data throughout a container through anonymous request, but does not provide access to container data. -Clients cannot enumerate blobs in the container by using anonymous request. -- Off. -Which restricts access to only the storage account owner. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.Blob.BlobContainerPublicAccessType] -Parameter Sets: (All) -Aliases: PublicAccess -Accepted values: Off, Container, Blob, Unknown - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - -[Set-AzureStorageContainerAcl](./Set-AzureStorageContainerAcl.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerSASToken.md deleted file mode 100644 index 433ef13856..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerSASToken.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6FF04E82-4921-4F7B-83D0-6997316BC5FD -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainersastoken -schema: 2.0.0 ---- - -# New-AzureStorageContainerSASToken - -## SYNOPSIS -Generates an SAS token for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageContainerSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageContainerSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainerSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure storage container. - -## EXAMPLES - -### Example 1: Generate a container SAS token with full container permission -``` -PS C:\>New-AzureStorageContainerSASToken -Name "Test" -Permission rwdl -``` - -This example generates a container SAS token with full container permission. - -### Example 2: Generate multiple container SAS token by pipeline -``` -PS C:\>Get-AzureStorageContainer -Container test* | New-AzureStorageContainerSASToken -Permission rwdl -``` - -This example generates multiple container SAS tokens by using the pipeline. - -### Example 3: Generate container SAS token with shared access policy -``` -PS C:\>New-AzureStorageContainerSASToken -Name "Test" -Policy "PolicyName" -``` - -This example generates a container SAS token with shared access policy. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the shared access signature becomes invalid. -If the user sets the start time but not the expiry time, the expiry time is set to the start time plus one hour. -If neither the start time nor the expiry time is specified, the expiry time is set to the current time plus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for a storage container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure Stored Access Policy. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageBlobSASToken](./New-AzureStorageBlobSASToken.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index c61c46d722..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C324F28A-7215-4F10-A012-92B4F6544BC0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 ---- - -# New-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageContainerStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage container. - -## EXAMPLES - -### Example 1: Create a stored access policy in a storage container -``` -PS C:\>New-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy01" -``` - -This command creates an access policy named Policy01 in the storage container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this SAS token. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContext.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageContext.md deleted file mode 100644 index f77aa7cd83..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageContext.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 383402B2-6B7C-41AB-AFF9-36C86156B0A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragecontext -schema: 2.0.0 ---- - -# New-AzureStorageContext - -## SYNOPSIS -Creates an Azure Storage context. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AccountNameAndKey (Default) -``` -New-AzureStorageContext [-StorageAccountName] [-StorageAccountKey] [-Protocol ] - [-Endpoint ] [] -``` - -### AccountNameAndKeyEnvironment -``` -New-AzureStorageContext [-StorageAccountName] [-StorageAccountKey] [-Protocol ] - -Environment [] -``` - -### AnonymousAccount -``` -New-AzureStorageContext [-StorageAccountName] [-Anonymous] [-Protocol ] [-Endpoint ] - [] -``` - -### AnonymousAccountEnvironment -``` -New-AzureStorageContext [-StorageAccountName] [-Anonymous] [-Protocol ] -Environment - [] -``` - -### SasToken -``` -New-AzureStorageContext [-StorageAccountName] -SasToken [-Protocol ] - [-Endpoint ] [] -``` - -### SasTokenWithAzureEnvironment -``` -New-AzureStorageContext [-StorageAccountName] -SasToken -Environment - [] -``` - -### ConnectionString -``` -New-AzureStorageContext -ConnectionString [] -``` - -### LocalDevelopment -``` -New-AzureStorageContext [-Local] [] -``` - -## DESCRIPTION -The **New-AzureStorageContext** cmdlet creates an Azure Storage context. - -## EXAMPLES - -### Example 1: Create a context by specifying a storage account name and key -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -``` - -This command creates a context for the account named ContosoGeneral that uses the specified key. - -### Example 2: Create a context by specifying a connection string -``` -C:\PS>New-AzureStorageContext -ConnectionString "DefaultEndpointsProtocol=https;AccountName=ContosoGeneral;AccountKey=< Storage Key for ContosoGeneral ends with == >;" -``` - -This command creates a context based on the specified connection string for the account ContosoGeneral. - -### Example 3: Create a context for an anonymous storage account -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -Anonymous -Protocol "http" -``` - -This command creates a context for anonymous use for the account named ContosoGeneral. -The command specifies HTTP as a connection protocol. - -### Example 4: Create a context by using the local development storage account -``` -C:\PS>New-AzureStorageContext -Local -``` - -This command creates a context by using the local development storage account. -The command specifies the *Local* parameter. - -### Example 5: Get the container for the local developer storage account -``` -C:\PS>New-AzureStorageContext -Local | Get-AzureStorageContainer -``` - -This command creates a context by using the local development storage account, and then passes the new context to the **Get-AzureStorageContainer** cmdlet by using the pipeline operator. -The command gets the Azure Storage container for the local developer storage account. - -### Example 6: Get multiple containers -``` -C:\PS>$Context01 = New-AzureStorageContext -Local -PS C:\> $Context02 = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -PS C:\> ($Context01, $Context02) | Get-AzureStorageContainer -``` - -The first command creates a context by using the local development storage account, and then stores that context in the $Context01 variable. -The second command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that context in the $Context02 variable. -The final command gets the containers for the contexts stored in $Context01 and $Context02 by using **Get-AzureStorageContainer**. - -### Example 7: Create a context with an endpoint -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Endpoint "contosoaccount.core.windows.net" -``` - -This command creates an Azure Storage context that has the specified storage endpoint. -The command creates the context for the account named ContosoGeneral that uses the specified key. - -### Example 8: Create a context with a specified environment -``` -C:\PS>New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -Environment "AzureChinaCloud" -``` - -This command creates an Azure storage context that has the specified Azure environment. -The command creates the context for the account named ContosoGeneral that uses the specified key. - -### Example 9: Create a context by using an SAS token -``` -C:\PS>$SasToken = New-AzureStorageContainerSASToken -Name "ContosoMain" -Permission "rad" -PS C:\> $Context = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -SasToken $SasToken -PS C:\> $Context | Get-AzureStorageBlob -Container "ContosoMain" -``` - -The first command generates an SAS token by using the **New-AzureStorageContainerSASToken** cmdlet for the container named ContosoMain, and then stores that token in the $SasToken variable. -That token is for read, add, update, and delete permissions. -The second command creates a context for the account named ContosoGeneral that uses the SAS token stored in $SasToken, and then stores that context in the $Context variable. -The final command lists all the blobs associated with the container named ContosoMain by using the context stored in $Context. - -## PARAMETERS - -### -Anonymous -Indicates that this cmdlet creates an Azure Storage context for anonymous logon. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: AnonymousAccount, AnonymousAccountEnvironment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionString -Specifies a connection string for the Azure Storage context. - -```yaml -Type: System.String -Parameter Sets: ConnectionString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -Specifies the endpoint for the Azure Storage context. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKey, AnonymousAccount, SasToken -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Environment -Specifies the Azure environment. -The acceptable values for this parameter are: AzureCloud and AzureChinaCloud. -For more information, type `Get-Help Get-AzureEnvironment`. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKeyEnvironment, AnonymousAccountEnvironment -Aliases: Name, EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SasTokenWithAzureEnvironment -Aliases: Name, EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Local -Indicates that this cmdlet creates a context by using the local development storage account. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: LocalDevelopment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Transfer Protocol (https/http). - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken -Aliases: -Accepted values: Http, Https - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SasToken -Specifies a Shared Access Signature (SAS) token for the context. - -```yaml -Type: System.String -Parameter Sets: SasToken, SasTokenWithAzureEnvironment -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies an Azure Storage account key. -This cmdlet creates a context for the key that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKey, AccountNameAndKeyEnvironment -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies an Azure Storage account name. -This cmdlet creates a context for the account that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: AccountNameAndKey, AccountNameAndKeyEnvironment, AnonymousAccount, AnonymousAccountEnvironment, SasToken, SasTokenWithAzureEnvironment -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.AzureStorageContext - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[New-AzureStorageContainerSASToken](./New-AzureStorageContainerSASToken.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageDirectory.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageDirectory.md deleted file mode 100644 index e3f030b197..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageDirectory.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 65962F9A-CC79-4B8B-9208-A993708FD36F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragedirectory -schema: 2.0.0 ---- - -# New-AzureStorageDirectory - -## SYNOPSIS -Creates a directory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -New-AzureStorageDirectory [-ShareName] [-Path] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -New-AzureStorageDirectory [-Share] [-Path] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -### Directory -``` -New-AzureStorageDirectory [-Directory] [-Path] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageDirectory** cmdlet creates a directory. -This cmdlet returns a **CloudFileDirectory** object. - -## EXAMPLES - -### Example 1: Create a folder in a file share -``` -PS C:\>New-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" -``` - -This command creates a folder named ContosoWorkingFolder in the file share named ContosoShare06. - -### Example 2: Create a folder in a file share specified in a file share object -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" | New-AzureStorageDirectory -Path "ContosoWorkingFolder" -``` - -This command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then passes it to the current cmdlet by using the pipeline operator. -The current cmdlet creates the folder named ContosoWorkingFolder in ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet creates the folder in the location that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -This cmdlet creates a folder for the path that this cmdlet specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet creates a folder in the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet creates a folder in the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageFileSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageFileSASToken.md deleted file mode 100644 index b9113f25ff..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageFileSASToken.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BB139312-A536-4B61-A005-6CAF02BE1637 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragefilesastoken -schema: 2.0.0 ---- - -# New-AzureStorageFileSASToken - -## SYNOPSIS -Generates a shared access signature token for a Storage file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameSasPermission -``` -New-AzureStorageFileSASToken [-ShareName] [-Path] [-Permission ] - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### NameSasPolicy -``` -New-AzureStorageFileSASToken [-ShareName] [-Path] -Policy - [-Protocol ] [-IPAddressOrRange ] [-StartTime ] - [-ExpiryTime ] [-FullUri] [-Context ] [-DefaultProfile ] - [] -``` - -### FileSasPermission -``` -New-AzureStorageFileSASToken -File [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-DefaultProfile ] [] -``` - -### FileSasPolicy -``` -New-AzureStorageFileSASToken -File -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageFileSASToken** cmdlet generates a shared access signature token for an Azure Storage file. - -## EXAMPLES - -### Example 1: Generate a shared access signature token that has full file permissions -``` -PS C:\> New-AzureStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" -``` - -This command generates a shared access signature token that has full permissions for the file that is named FilePath. - -### Example 2: Generate a shared access signature token that has a time limit -``` -PS C:\> $StartTime = Get-Date -PS C:\> $EndTime = $StartTime.AddHours(2.0) -PS C:\> New-AzureStorageFileSASToken -ShareName "ContosoShare" -Path "FilePath" -Permission "rwd" -StartTime $StartTime -ExpiryTime $EndTime -``` - -The first command creates a **DateTime** object by using the Get-Date cmdlet. -The command stores the current time in the $StartTime variable. -The second command adds two hours to the object in $StartTime, and then stores the result in the $EndTime variable. -This object is a time two hours in the future. -The third command generates a shared access signature token that has the specified permissions. -This token becomes valid at the current time. -The token remains valid until time stored in $EndTime. - -## PARAMETERS - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileSasPermission, FileSasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the file relative to a Storage share. - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions for a Storage file. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, FileSasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the stored access policy for a file. - -```yaml -Type: System.String -Parameter Sets: NameSasPolicy, FileSasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: NameSasPermission, NameSasPolicy -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameters: Context (ByValue) - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareSASToken](./New-AzureStorageShareSASToken.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueue.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueue.md deleted file mode 100644 index 105cb09751..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueue.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E9500392-6BE1-46EC-9AF5-9234281025E6 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeue -schema: 2.0.0 ---- - -# New-AzureStorageQueue - -## SYNOPSIS -Creates a storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageQueue [-Name] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageQueue** cmdlet creates a storage queue in Azure. - -## EXAMPLES - -### Example 1: Create an Azure storage queue -``` -PS C:\>New-AzureStorageQueue -Name "queueabc" -``` - -This example creates a storage queue named queueabc. - -### Example 2: Create multiple azure storage queues -``` -PS C:\>"queue1 queue2 queue3".split() | New-AzureStorageQueue -``` - -This example creates multiple storage queues. -It uses the Split method of the .NET String class and then passes the names on the pipeline. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the queue. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageQueue - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueue](./Get-AzureStorageQueue.md) - -[Remove-AzureStorageQueue](./Remove-AzureStorageQueue.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueSASToken.md deleted file mode 100644 index cc3af057c3..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueSASToken.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 42C669B6-B621-454C-B897-262E1C8E76E3 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeuesastoken -schema: 2.0.0 ---- - -# New-AzureStorageQueueSASToken - -## SYNOPSIS -Generates a shared access signature token for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageQueueSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageQueueSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageQueueSASToken** cmdlet generates shared access signature token for an Azure storage queue. - -## EXAMPLES - -### Example 1: Generate a queue SAS token with full permission -``` -PS C:\>New-AzureStorageQueueSASToken -Name "Test" -Permission raup -``` - -This example generates a queue SAS token with full permission. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the shared access signature is no longer valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for a storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies an Azure stored access policy. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies when the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index 45c8485030..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 351145AC-7C1E-4EB7-A17D-B8B7D8ED8DAB -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 ---- - -# New-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageQueueStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage queue. - -## EXAMPLES - -### Example 1: Create a stored access policy in a storage queue -``` -PS C:\>New-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy01" -``` - -This command creates an access policy named Policy01 in the storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShare.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageShare.md deleted file mode 100644 index 08c3de8803..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShare.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FCDCEF0B-6E2C-480E-9841-EF4E64D61D54 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestorageshare -schema: 2.0.0 ---- - -# New-AzureStorageShare - -## SYNOPSIS -Creates a file share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageShare [-Name] [-Context ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageShare** cmdlet creates a file share. - -## EXAMPLES - -### Example 1: Create a file share -``` -PS C:\>New-AzureStorageShare -Name "ContosoShare06" -``` - -This command creates a file share named ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 a file share. -This cmdlet creates a file share that has the name that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageShare](./Remove-AzureStorageShare.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareSASToken.md deleted file mode 100644 index 1a95cd5c0d..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareSASToken.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BDF42420-3616-4A64-9562-1A896F828728 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragesharesastoken -schema: 2.0.0 ---- - -# New-AzureStorageShareSASToken - -## SYNOPSIS -Generate Shared Access Signature token for Azure Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageShareSASToken [-ShareName] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageShareSASToken [-ShareName] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageShareSASToken** cmdlet generates a shared access signature token for an Azure Storage share. - -## EXAMPLES - -### Example 1: Generate a shared access signature token for a share -``` -PS C:\>New-AzureStorageShareSASToken -ShareName "ContosoShare" -Permission "rwdl" -``` - -This command creates a shared access signature token for the share named ContosoShare. - -### Example 2: Generate multiple shared access signature token by using the pipeline -``` -PS C:\>Get-AzureStorageShare -Prefix "test" | New-AzureStorageShareSASToken -Permission "rwdl" -``` - -This command gets all the Storage shares that match the prefix test. -The command passes them to the current cmdlet by using the pipeline operator. -The current cmdlet creates a shared access token for each Storage share that has the specified permissions. - -### Example 3: Generate a shared access signature token that uses a shared access policy -``` -PS C:\>New-AzureStorageShareSASToken -ShareName "ContosoShare" -Policy "ContosoPolicy03" -``` - -This command creates a shared access signature token for the Storage share named ContosoShare that has the policy named ContosoPolicy03. - -## PARAMETERS - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the shared access signature becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet return the full blob URI and the shared access signature token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the permissions in the token to access the share and files under the share. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the stored access policy for a share. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the shared access signature becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES -* Keywords: common, azure, services, data, storage, blob, queue, table - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageFileSASToken](./New-AzureStorageFileSASToken.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 7e1ff3ebd1..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 37E76360-B683-407C-9AEF-7138374562D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragesharestoredaccesspolicy -schema: 2.0.0 ---- - -# New-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy on a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **New-AzureStorageShareStoredAccessPolicy** cmdlet creates a stored access policy on an Azure Storage share. - -## EXAMPLES - -### Example 1: Create a stored access policy in a share -``` -PS C:\>New-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" -``` - -This command creates a stored access policy that has full permission in a share. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the Storage share or files under it. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTable.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageTable.md deleted file mode 100644 index 25f940ad6c..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTable.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3B4F32F3-51ED-4851-B38F-172658186C96 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetable -schema: 2.0.0 ---- - -# New-AzureStorageTable - -## SYNOPSIS -Creates a storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageTable [-Name] [-Context ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -The **New-AzureStorageTable** cmdlet creates a storage table associated with the storage account in Azure. - -## EXAMPLES - -### Example 1: Create an azure storage table -``` -PS C:\>New-AzureStorageTable -Name "tableabc" -``` - -This command creates a storage table with a name of tableabc. - -### Example 2: Create multiple azure storage tables -``` -PS C:\>"table1 table2 table3".split() | New-AzureStorageTable -``` - -This command creates multiple tables. -It uses the **Split** method of the .NET **String** class and then passes the names on the pipeline. - -## PARAMETERS - -### -Context -Specifies the storage context. -To create it, you can use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new table. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageTable - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTable](./Get-AzureStorageTable.md) - -[Remove-AzureStorageTable](./Remove-AzureStorageTable.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableSASToken.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableSASToken.md deleted file mode 100644 index 93d128d177..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableSASToken.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3CFA6E31-E243-4B22-AE8F-1942DD324639 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetablesastoken -schema: 2.0.0 ---- - -# New-AzureStorageTableSASToken - -## SYNOPSIS -Generates an SAS token for an Azure Storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SasPolicy -``` -New-AzureStorageTableSASToken [-Name] -Policy [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-StartPartitionKey ] [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] - [-Context ] [-DefaultProfile ] [] -``` - -### SasPermission -``` -New-AzureStorageTableSASToken [-Name] [-Permission ] [-Protocol ] - [-IPAddressOrRange ] [-StartTime ] [-ExpiryTime ] [-FullUri] - [-StartPartitionKey ] [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageTableSASToken** cmdlet generates a Shared Access Signature (SAS) token for an Azure Storage table. - -## EXAMPLES - -### Example 1: Generate an SAS token that has full permissions for a table -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Permission "raud" -``` - -This command generates an SAS token with full permissions for the table named ContosoResources. -That token is for read, add, update, and delete permissions. - -### Example 2: Generate an SAS token for a range of partitions -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Permission "raud" -StartPartitionKey "a" -EndPartitionKey "b" -``` - -This command generates and SAS token with full permissions for the table named ContosoResources. -The command limits the token to the range that the *StartPartitionKey* and *EndPartitionKey* parameters specify. - -### Example 3: Generate an SAS token that has a stored access policy for a table -``` -C:\PS>New-AzureStorageTableSASToken -Name "ContosoResources" -Policy "ClientPolicy01" -``` - -This command generates an SAS token for the table named ContosoResources. -The command specifies the stored access policy named ClientPolicy01. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndPartitionKey -Specifies the partition key of the end of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: endpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRowKey -Specifies the row key for the end of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: endrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpiryTime -Specifies when the SAS token expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullUri -Indicates that this cmdlet returns the full queue URI with the SAS token. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. -The range is inclusive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an Azure Storage table. -This cmdlet creates an SAS token for the table that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions for an Azure Storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: SasPermission -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a stored access policy, which includes the permissions for this SAS token. - -```yaml -Type: System.String -Parameter Sets: SasPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol permitted for a request. -The acceptable values for this parameter are: -* HttpsOnly -* HttpsOrHttp -The default value is HttpsOrHttp. - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.SharedAccessProtocol] -Parameter Sets: (All) -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartPartitionKey -Specifies the partition key of the start of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: startpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartRowKey -Specifies the row key for the start of the range for the token that this cmdlet creates. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: startrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies when the SAS token becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index df0ca5c60e..0000000000 --- a/azurermps-2.5.0/Azure.Storage/New-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: CF3B6E3B-3FC1-4871-AFE0-366B17A9E4F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/new-azurestoragetablestoredaccesspolicy -schema: 2.0.0 ---- - -# New-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Creates a stored access policy for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **New-AzureStorageTableStoredAccessPolicy** cmdlet creates a stored access policy for an Azure storage table. - -## EXAMPLES - -### Example 1: Create a stored access policy in a table -``` -PS C:\>New-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy02" -``` - -This command creates an access policy named Policy02 in the storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageBlob.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageBlob.md deleted file mode 100644 index f86a3c94aa..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageBlob.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 03EC0D20-C737-4B2B-B8D9-71D06A938FAD -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestorageblob -schema: 2.0.0 ---- - -# Remove-AzureStorageBlob - -## SYNOPSIS -Removes the specified storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Remove-AzureStorageBlob [-Blob] [-Container] [-DeleteSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Remove-AzureStorageBlob -CloudBlob [-DeleteSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Remove-AzureStorageBlob -CloudBlobContainer [-Blob] [-DeleteSnapshot] [-Force] - [-PassThru] [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageBlob** cmdlet removes the specified blob from a storage account in Azure. - -## EXAMPLES - -### Example 1: Remove a storage blob by name -``` -PS C:\>Remove-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" -``` - -This command removes a blob identified by its name. - -### Example 2: Remove a storage blob using the pipeline -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" -Blob "BlobName" | Remove-AzureStorageBlob -``` - -This command uses the pipeline. - -### Example 3: Remove storage blobs using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Container container* | Remove-AzureStorageBlob -Blob "BlobName" -``` - -This command uses the asterisk (*) wildcard character and the pipeline to retrieve the blob or blobs and then removes them. - -## PARAMETERS - -### -Blob -Specifies the name of the blob you want to remove. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a cloud blob. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -You can use the Get-AzureStorageContainer cmdlet to get it. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can use the New-AzureStorageContext cmdlet to create it. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSnapshot -Specifies that all snapshots be deleted, but not the base blob. -If this parameter is not specified, the base blob and its snapshots are deleted together. -The user is prompted to confirm the delete operation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes the blob and its snapshot without confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the Azure profile for the cmdlet to read. -If not specified, the cmdlet reads from the default profile. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Set-AzureStorageBlobContent](./Set-AzureStorageBlobContent.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageCORSRule.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageCORSRule.md deleted file mode 100644 index bf7738c97a..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageCORSRule.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 26E06BA3-C550-40A5-B8E3-FEC8E9BF3867 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecorsrule -schema: 2.0.0 ---- - -# Remove-AzureStorageCORSRule - -## SYNOPSIS -Removes CORS for a Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageCORSRule [-ServiceType] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageCORSRule** cmdlet removes Cross-Origin Resource Sharing (CORS) for an Azure Storage service. -This cmdlet deletes all CORS rules in a Storage service type. -The types of storage services for this cmdlet are Blob, Table, Queue, and File. - -## EXAMPLES - -### Example 1: Remove CORS rules for the blob service -``` -PS C:\>Remove-AzureStorageCORSRule -ServiceType Blob -``` - -This command removes CORS rules for the Blob service type. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -To obtain the storage context, the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet removes rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageCORSRule](./Get-AzureStorageCORSRule.md) - -[Set-AzureStorageCORSRule](./Set-AzureStorageCORSRule.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainer.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainer.md deleted file mode 100644 index 030fc3811e..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainer.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 6A46DA60-2ACF-4842-B5B3-58944264854A -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecontainer -schema: 2.0.0 ---- - -# Remove-AzureStorageContainer - -## SYNOPSIS -Removes the specified storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageContainer [-Name] [-Force] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageContainer** cmdlet removes the specified storage container in Azure. - -## EXAMPLES - -### Example 1: Remove a container -``` -PS C:\>Remove-AzureStorageContainer -Name "MyTestContainer" -``` - -This example removes a container named MyTestContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies a context for the container you want to remove. -You can use the New-AzureStorageContext cmdlet to create it. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 3e69b32b08..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3E79EE05-7E52-4C54-B985-441BC2599925 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 ---- - -# Remove-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageContainerStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage container. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage container -``` -PS C:\>Remove-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy03" -``` - -This command removes an access policy named Policy03 from the stored container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageContainerStoredAccessPolicy](./Set-AzureStorageContainerStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageDirectory.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageDirectory.md deleted file mode 100644 index 08d627c0ec..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageDirectory.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 53988D79-1F8B-4138-9F92-2912D418C121 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragedirectory -schema: 2.0.0 ---- - -# Remove-AzureStorageDirectory - -## SYNOPSIS -Deletes a directory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageDirectory [-ShareName] [-Path] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageDirectory [-Share] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Remove-AzureStorageDirectory [-Directory] [[-Path] ] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageDirectory** cmdlet deletes a directory. - -## EXAMPLES - -### Example 1: Delete a folder -``` -PS C:\>Remove-AzureStorageDirectory -ShareName "ContosoShare06" -Path "ContosoWorkingFolder" -``` - -This command deletes the folder named ContosoWorkingFolder from the file share named ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet removes the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the **Get-AzureStorageFile** cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that, if this cmdlet succeeds, it returns a value of $True. -If you specify this parameter, and if the cmdlet is unsuccessful because of an inappropriate value for the _Path_ parameter, the cmdlet returns an error. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a folder. -If the folder that this parameter specifies is empty, this cmdlet deletes that folder. -If the folder is not empty, this cmdlet makes no change, and returns an error. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: Directory -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes a folder under the file share that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet removes a folder under the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageFile.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageFile.md deleted file mode 100644 index 43294a2352..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageFile.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 811671E9-592E-4E58-8174-34D665206A65 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragefile -schema: 2.0.0 ---- - -# Remove-AzureStorageFile - -## SYNOPSIS -Deletes a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageFile [-ShareName] [-Path] [-PassThru] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageFile [-Share] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Remove-AzureStorageFile [-Directory] [-Path] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Remove-AzureStorageFile [-File] [-PassThru] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageFile** cmdlet deletes a file. - -## EXAMPLES - -### Example 1: Delete a file from a file share -``` -PS C:\>Remove-AzureStorageFile -ShareName "ContosoShare06" -Path "ContosoFile22" -``` - -This command deletes the file that is named ContosoFile22 from the file share named ContosoShare06. - -### Example 2: Get a file from a file share by using a file share object -``` -PS C:\>Get-AzureStorageShare -Name "ContosoShare06" | Remove-AzureStorageFile -Path "ContosoFile22" -``` - -This command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then passes that object to the current cmdlet by using the pipeline operator. -The current command deletes the file that is named ContosoFile22 from ContosoShare06. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet removes a file in the folder that this parameter specifies. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -File -Specifies a file as a **CloudFile** object. -This cmdlet removes the file that this parameter specifies. -To obtain a **CloudFile** object, use the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file. -This cmdlet deletes the file that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName, Share, Directory -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes the file in the share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet removes the file in the share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueue.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueue.md deleted file mode 100644 index 48546fff71..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueue.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 22975A89-CAFF-4F18-8DCE-B695413FBAC7 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragequeue -schema: 2.0.0 ---- - -# Remove-AzureStorageQueue - -## SYNOPSIS -Removes a storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageQueue [-Name] [-Force] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageQueue** cmdlet removes a storage queue. - -## EXAMPLES - -### Example 1: Remove a storage queue by name -``` -PS C:\>Remove-AzureStorageQueue "ContosoQueue01" -``` - -This command removes a queue named ContosoQueue01. - -### Example 2: Remove multiple storage queues -``` -PS C:\>Get-AzureStorageQueue "Contoso*" | Remove-AzureStorageQueue -``` - -This command removes all queues with names that start with Contoso. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -To obtain the storage context, the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the queue to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Queue - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueue](./Get-AzureStorageQueue.md) - -[New-AzureStorageQueue](./New-AzureStorageQueue.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index 6ae2ca5ef3..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 80DE5D60-93F8-4509-AA9C-F54E4AB70013 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 ---- - -# Remove-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-PassThru] - [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageQueueStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage queue. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage queue -``` -PS C:\>Remove-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy04" -``` - -This command removes an access policy named Policy04 from the storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Set-AzureStorageQueueStoredAccessPolicy](./Set-AzureStorageQueueStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShare.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShare.md deleted file mode 100644 index 71d2c06a65..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShare.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FF3AD436-CA33-4A52-8580-D2345D80A231 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestorageshare -schema: 2.0.0 ---- - -# Remove-AzureStorageShare - -## SYNOPSIS -Deletes a file share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Remove-AzureStorageShare [-Name] [-IncludeAllSnapshot] [-Force] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Remove-AzureStorageShare [-Share] [-IncludeAllSnapshot] [-Force] [-PassThru] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageShare** cmdlet deletes a file share. - -## EXAMPLES - -### Example 1: Remove a file share -``` -PS C:\>Remove-AzureStorageShare -Name "ContosoShare06" -``` - -This command removes the file share named ContosoShare06. - -### Example 2: Remove a file share and all its snapshots -``` -PS C:\>Remove-AzureStorageShare -Name "ContosoShare06" -IncludeAllSnapshot -``` - -This command removes the file share named ContosoShare06 and all its snapshots. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Force to remove the share with all of its snapshots, and all content. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAllSnapshot -Remove File Share with all of its snapshots - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the file share. -This cmdlet deletes the file share that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet removes the object that this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShare](./New-AzureStorageShare.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index 01eb74fff6..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: E2CCDA8F-2D45-4F25-B297-337B7AB021E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragesharestoredaccesspolicy -schema: 2.0.0 ---- - -# Remove-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageShareStoredAccessPolicy** cmdlet removes a stored access policy from an Azure Storage share. - -## EXAMPLES - -### Example 1: Remove a stored access policy from an Azure Storage share -``` -PS C:\>Remove-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -``` - -This command removes a stored access policy named GeneralPolicy from ContosoShare. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the Storage share name for which this cmdlet removes a policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Set-AzureStorageShareStoredAccessPolicy](./Set-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTable.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTable.md deleted file mode 100644 index ef865acef4..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTable.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 1B29AB8C-95DD-4C4F-86E2-2F81E8020CEA -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragetable -schema: 2.0.0 ---- - -# Remove-AzureStorageTable - -## SYNOPSIS -Removes a storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageTable [-Name] [-Force] [-PassThru] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AzureStorageTable** cmdlet removes one or more storage tables from a storage account in Azure. - -## EXAMPLES - -### Example 1: Remove a table -``` -PS C:\>Remove-AzureStorageTable -Name "TableABC" -``` - -This command removes a table. - -### Example 2: Remove several tables -``` -PS C:\>Get-AzureStorageTable table* | Remove-AzureStorageTable -``` - -This example uses a wildcard character with the *Name* parameter to get all tables that match the pattern table and then passes the result on the pipeline to remove the tables. - -## PARAMETERS - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the table to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Table - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTable](./Get-AzureStorageTable.md) diff --git a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 8bc3763b51..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Remove-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 30CC0D80-505A-4988-B4EC-3B7BC5B76F5D -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/remove-azurestoragetablestoredaccesspolicy -schema: 2.0.0 ---- - -# Remove-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Removes a stored access policy from an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-PassThru] - [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AzureStorageTableStoredAccessPolicy** cmdlet removes a stored access policy from an Azure storage table. - -## EXAMPLES - -### Example 1: Remove a stored access policy from a storage table -``` -PS C:\>Remove-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy05" -``` - -This command removes policy named Policy05 from storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Boolean** that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name of the stored access policy that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Set-AzureStorageTableStoredAccessPolicy](./Set-AzureStorageTableStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageBlobContent.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageBlobContent.md deleted file mode 100644 index ea9b71e653..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageBlobContent.md +++ /dev/null @@ -1,417 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: F20A5FD3-6EC3-4EFE-988C-75F8583961A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageblobcontent -schema: 2.0.0 ---- - -# Set-AzureStorageBlobContent - -## SYNOPSIS -Uploads a local file to an Azure Storage blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SendManual (Default) -``` -Set-AzureStorageBlobContent [-File] [-Container] [-Blob ] [-BlobType ] - [-Properties ] [-Metadata ] [-PremiumPageBlobTier ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Set-AzureStorageBlobContent [-File] [-Blob ] -CloudBlobContainer - [-BlobType ] [-Properties ] [-Metadata ] - [-PremiumPageBlobTier ] [-Force] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Set-AzureStorageBlobContent [-File] -CloudBlob [-BlobType ] - [-Properties ] [-Metadata ] [-PremiumPageBlobTier ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageBlobContent** cmdlet uploads a local file to an Azure Storage blob. - -## EXAMPLES - -### Example 1: Upload a named file -``` -PS C:\>Set-AzureStorageBlobContent -Container "ContosoUpload" -File ".\PlanningData" -Blob "Planning2015" -``` - -This command uploads the file that is named PlanningData to a blob named Planning2015. - -### Example 2: Upload all files under the current folder -``` -PS C:\>Get-ChildItem -File -Recurse | Set-AzureStorageBlobContent -Container "ContosoUploads" -``` - -This command uses the core Windows PowerShell cmdlet Get-ChildItem to get all the files in the current folder and in subfolders, and then passes them to the current cmdlet by using the pipeline operator. -The **Set-AzureStorageBlobContent** cmdlet uploads the files to the container named ContosoUploads. - -### Example 3: Overwrite an existing blob -``` -PS C:\>Get-AzureStorageBlob -Container "ContosoUploads" -Blob "Planning2015" | Set-AzureStorageBlobContent -File "ContosoPlanning" -``` - -This command gets the blob named Planning2015 in the ContosoUploads container by using the Get-AzureStorageBlob cmdlet, and then passes that blob to the current cmdlet. -The command uploads the file that is named ContosoPlanning as Planning2015. -This command does not specify the *Force* parameter. -The command prompts you for confirmation. -If you confirm the command, the cmdlet overwrites the existing blob. - -### Example 4: Upload a file to a container by using the pipeline -``` -PS C:\>Get-AzureStorageContainer -Container "ContosoUpload*" | Set-AzureStorageBlobContent -File "ContosoPlanning" -Blob "Planning2015" -``` - -This command gets the container that starts with the string ContosoUpload by using the **Get-AzureStorageContainer** cmdlet, and then passes that blob to the current cmdlet. -The command uploads the file that is named ContosoPlanning as Planning2015. - -### Example 5: Upload a file to page blob with metadata and PremiumPageBlobTier as P10 -``` -PS C:\>$Metadata = @{"key" = "value"; "name" = "test"} -PS C:\> Set-AzureStorageBlobContent -File "ContosoPlanning" -Container "ContosoUploads" -Metadata $Metadata -BlobType Page -PremiumPageBlobTier P10 -``` - -The first command creates a hash table that contains metadata for a blob, and stores that hash table in the $Metadata variable. -The second command uploads the file that is named ContosoPlanning to the container named ContosoUploads. -The blob includes the metadata stored in $Metadata, and has PremiumPageBlobTier as P10. - -### Example 6: Upload a file to blob with specified blob properties -``` -PS C:\> Set-AzureStorageBlobContent -File "ContosoPlanning" -Container "ContosoUploads" -Properties @{"ContentType" = "image/jpeg"; "ContentMD5" = "i727sP7HigloQDsqadNLHw=="} -``` - -This command uploads the file that is named ContosoPlanning to the container named ContosoUploads with specified blob properties. - -## PARAMETERS - -### -Blob -Specifies the name of a blob. -This cmdlet uploads a file to the Azure Storage blob that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: SendManual, ContainerPipeline -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobType -Specifies the type for the blob that this cmdlet uploads. -The acceptable values for this parameter are: -- Block -- Page -The default value is Block. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Block, Page, Append - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet uploads content to a blob in the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of a container. -This cmdlet uploads a file to a blob in the container that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: SendManual -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a local file path for a file to upload as blob content. - -```yaml -Type: System.String -Parameter Sets: SendManual -Aliases: FullName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ContainerPipeline, BlobPipeline -Aliases: FullName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites an existing blob without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies metadata for the uploaded blob. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PremiumPageBlobTier -Page Blob Tier - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.PremiumPageBlobTier -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies properties for the uploaded blob. -The supported properties are: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentMD5, ContentType. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobContent](./Get-AzureStorageBlobContent.md) - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Remove-AzureStorageBlob](./Remove-AzureStorageBlob.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageCORSRule.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageCORSRule.md deleted file mode 100644 index 3f0c98a36e..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageCORSRule.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 288B7B56-B934-45AF-BF56-4EB0DD827522 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecorsrule -schema: 2.0.0 ---- - -# Set-AzureStorageCORSRule - -## SYNOPSIS -Sets the CORS rules for a type of Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageCORSRule [-ServiceType] -CorsRules [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageCORSRule** cmdlet sets the Cross-Origin Resource Sharing (CORS) rules for a type of Azure Storage service. -The types of storage services for this cmdlet are Blob, Table, Queue, and File. -This cmdlet overwrites the existing rules. -To see the current rules, use the Get-AzureStorageCORSRule cmdlet. - -## EXAMPLES - -### Example 1: Assign CORS rules to the blob service -``` -PS C:\>$CorsRules = (@{ - AllowedHeaders=@("x-ms-blob-content-type","x-ms-blob-content-disposition"); - AllowedOrigins=@("*"); - MaxAgeInSeconds=30; - AllowedMethods=@("Get","Connect")}, - @{ - AllowedOrigins=@("http://www.fabrikam.com","http://www.contoso.com"); - ExposedHeaders=@("x-ms-meta-data*","x-ms-meta-customheader"); - AllowedHeaders=@("x-ms-meta-target*","x-ms-meta-customheader"); - MaxAgeInSeconds=30; - AllowedMethods=@("Put")}) -PS C:\> Set-AzureStorageCORSRule -ServiceType Blob -CorsRules $CorsRules -``` - -The first command assigns an array of rules to the $CorsRules variable. -This command uses standard extends over several lines in this code block. -The second command assigns the rules in $CorsRules to the Blob service type. - -### Example 2: Change properties of a CORS rule for blob service -``` -PS C:\>$CorsRules = Get-AzureStorageCORSRule -ServiceType Blob -PS C:\> $CorsRules[0].AllowedHeaders = @("x-ms-blob-content-type", "x-ms-blob-content-disposition") -PS C:\> $CorsRules[0].AllowedMethods = @("Get", "Connect", "Merge") -PS C:\> Set-AzureStorageCORSRule -ServiceType Blob -CorsRules $CorsRules -``` - -The first command gets the current CORS rules for the Blob type by using the **Get-AzureStorageCORSRule** cmdlet. -The command stores the rules in the $CorsRules array variable. -The second and third commands modify the first rule in $CorsRules. -The final command assigns the rules in $CorsRules to the Blob service type. -The revised rules overwrite the current CORS rules. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CorsRules -Specifies an array of CORS rules. -You can retrieve the existing rules using the Get-AzureStorageCORSRule cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a Boolean that reflects the success of the operation. -By default, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the Azure Storage service type for which this cmdlet assigns rules. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSCorsRule - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageCORSRule](./Get-AzureStorageCORSRule.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Remove-AzureStorageCORSRule](./Remove-AzureStorageCORSRule.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerAcl.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerAcl.md deleted file mode 100644 index beecff610e..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerAcl.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: BDEEF1EA-A785-4E17-9887-C2000BDFCF57 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecontaineracl -schema: 2.0.0 ---- - -# Set-AzureStorageContainerAcl - -## SYNOPSIS -Sets the public access permission to a storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageContainerAcl [-Name] [-Permission] [-PassThru] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageContainerAcl** cmdlet sets the public access permission to the specified storage container in Azure. - -## EXAMPLES - -### Example 1: Set azure storage container ACL by name -``` -PS C:\>Set-AzureStorageContainerAcl -Container "Container01" -Permission Off -PassThru -``` - -This command creates a container that has no public access. - -### Example 2: Set azure storage container ACL by using the pipeline -``` -PS C:\>Get-AzureStorageContainer container* | Set-AzureStorageContainerAcl -Permission Blob -PassThru -``` - -This command gets all storage containers whose name starts with container and then passes the result on the pipeline to set the permission for them all to Blob access. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can create it by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies the level of public access to this container. -By default, the container and any blobs in it can be accessed only by the owner of the storage account. -To grant anonymous users read permissions to a container and its blobs, you can set the container permissions to enable public access. -Anonymous users can read blobs in a publicly available container without authenticating the request. -The acceptable values for this parameter are: ---Container. -Provides full read access to a container and its blobs. -Clients can enumerate blobs in the container through anonymous request, but cannot enumerate containers in the storage account. ---Blob. -Provides read access to blob data in a container through anonymous request, but does not provide access to container data. -Clients cannot enumerate blobs in the container by using anonymous request. ---Off. -Restricts access to only the storage account owner. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.BlobContainerPublicAccessType -Parameter Sets: (All) -Aliases: PublicAccess -Accepted values: Off, Container, Blob, Unknown - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. -Server side time out for each request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageContainer - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[New-AzureStorageContainer](./New-AzureStorageContainer.md) - -[Remove-AzureStorageContainer](./Remove-AzureStorageContainer.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md deleted file mode 100644 index 5576731da0..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageContainerStoredAccessPolicy.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 730ECC60-72DE-46DA-A177-D5749F540710 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragecontainerstoredaccesspolicy -schema: 2.0.0 ---- - -# Set-AzureStorageContainerStoredAccessPolicy - -## SYNOPSIS -Sets a stored access policy for an Azure storage container. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageContainerStoredAccessPolicy [-Container] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageContainerStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage container. - -## EXAMPLES - -### Example 1: Set a stored access policy in a storage container with full permission -``` -PS C:\>Set-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy06" -Permission rwdl -``` - -This command sets an access policy named Policy06 for storage container named MyContainer. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the Azure storage container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Sets the start time to be $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage container. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageContainerStoredAccessPolicy](./Get-AzureStorageContainerStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageContainerStoredAccessPolicy](./New-AzureStorageContainerStoredAccessPolicy.md) - -[Remove-AzureStorageContainerStoredAccessPolicy](./Remove-AzureStorageContainerStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageFileContent.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageFileContent.md deleted file mode 100644 index 67afab45b0..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageFileContent.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FA98E64B-D589-4653-9ACC-86573FAF4550 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragefilecontent -schema: 2.0.0 ---- - -# Set-AzureStorageFileContent - -## SYNOPSIS -Uploads the contents of a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName (Default) -``` -Set-AzureStorageFileContent [-ShareName] [-Source] [[-Path] ] [-PassThru] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Share -``` -Set-AzureStorageFileContent [-Share] [-Source] [[-Path] ] [-PassThru] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### Directory -``` -Set-AzureStorageFileContent [-Directory] [-Source] [[-Path] ] [-PassThru] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageFileContent** cmdlet uploads the contents of a file to a file on a specified share. - -## EXAMPLES - -### Example 1: Upload a file in the current folder -``` -PS C:\>Set-AzureStorageFileContent -ShareName "ContosoShare06" -Source "DataFile37" -Path "ContosoWorkingFolder/CurrentDataFile" -``` - -This command uploads a file that is named DataFile37 in the current folder as a file that is named CurrentDataFile in the folder named ContosoWorkingFolder. - -### Example 2: Upload all the files in the current folder -``` -PS C:\>$CurrentFolder = (Get-Item .).FullName -PS C:\> $Container = Get-AzureStorageShare -Name "ContosoShare06" -PS C:\> Get-ChildItem -Recurse | Where-Object { $_.GetType().Name -eq "FileInfo"} | ForEach-Object { - $path=$_.FullName.Substring($Currentfolder.Length+1).Replace("\","/") - Set-AzureStorageFileContent -Share $Container -Source $_.FullName -Path $path -Force -} -``` - -This example uses several common Windows PowerShell cmdlets and the current cmdlet to upload all files from the current folder to the root folder of container ContosoShare06. -The first command gets the name of the current folder and stores it in the $CurrentFolder variable. -The second command uses the **Get-AzureStorageShare** cmdlet to get the file share named ContosoShare06, and then stores it in the $Container variable. -The final command gets the contents of the current folder and passes each one to the Where-Object cmdlet by using the pipeline operator. -That cmdlet filters out objects that are not files, and then passes the files to the ForEach-Object cmdlet. -That cmdlet runs a script block for each file that creates the appropriate path for it and then uses the current cmdlet to upload the file. -The result has the same name and same relative position with regard to the other files that this example uploads. -For more information about script blocks, type `Get-Help about_Script_Blocks`. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Directory -Specifies a folder as a **CloudFileDirectory** object. -This cmdlet uploads the file to the folder that this parameter specifies. -To obtain a directory, use the New-AzureStorageDirectory cmdlet. -You can also use the Get-AzureStorageFile cmdlet to obtain a directory. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: Directory -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites an existing Azure storage file. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the **AzureStorageFile** object that it creates or uploads. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of a file or folder. -This cmdlet uploads contents to the file that this parameter specifies, or to a file in the folder that this parameter specifies. -If you specify a folder, this cmdlet creates a file that has the same name as the source file. -If you specify a path of a file that does not exist, this cmdlet creates that file and saves the contents to that file. -If you specify a file that already exists, and you specify the _Force_ parameter, this cmdlet overwrites the contents of the file. -If you specify a file that already exists and you do not specify _Force_, this cmdlet makes no change, and returns an error. -If you specify a path of a folder that does not exist, this cmdlet makes no change, and returns an error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object. -This cmdlet uploads to a file in the file share this parameter specifies. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. -This object contains the storage context. -If you specify this parameter, do not specify the *Context* parameter. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share. -This cmdlet uploads to a file in the file share this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Specifies the source file that this cmdlet uploads. -If you specify a file that does not exist, this cmdlet returns an error. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: FullName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameters: Directory (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile - -## NOTES - -## RELATED LINKS - -[Remove-AzureStorageDirectory](./Remove-AzureStorageDirectory.md) - -[New-AzureStorageDirectory](./New-AzureStorageDirectory.md) - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md deleted file mode 100644 index 8b1dcf0718..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageQueueStoredAccessPolicy.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 4FB7E017-7D37-4EDB-BEC1-36629058B87C -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragequeuestoredaccesspolicy -schema: 2.0.0 ---- - -# Set-AzureStorageQueueStoredAccessPolicy - -## SYNOPSIS -Sets a stored access policy for an Azure storage queue. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageQueueStoredAccessPolicy [-Queue] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureStorageQueueStoredAccessPolicy** cmdlet sets a stored access policy for an Azure storage queue. - -## EXAMPLES - -### Example 1: Set a stored access policy in the queue with full permission -``` -PS C:\> Set-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07" -Permission arup -``` - -This command sets an access policy named Policy07 for storage queue named MyQueue. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that this cmdlet sets the start time to be $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage queue. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Specifies the Azure storage queue name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageQueueStoredAccessPolicy](./Get-AzureStorageQueueStoredAccessPolicy.md) - -[New-AzureStorageQueueStoredAccessPolicy](./New-AzureStorageQueueStoredAccessPolicy.md) - -[Remove-AzureStorageQueueStoredAccessPolicy](./Remove-AzureStorageQueueStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md deleted file mode 100644 index 3616b50dd7..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceLoggingProperty.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5422429E-C609-4C1F-A021-E2A085B5F74E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageserviceloggingproperty -schema: 2.0.0 ---- - -# Set-AzureStorageServiceLoggingProperty - -## SYNOPSIS -Modifies logging for Azure Storage services. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageServiceLoggingProperty [-ServiceType] [-Version ] - [-RetentionDays ] [-LoggingOperations ] [-PassThru] [-Context ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageServiceLoggingProperty** cmdlet modifies logging for Azure Storage services. - -## EXAMPLES - -### Example 1: Modify logging properties for the Blob service -``` -C:\PS>Set-AzureStorageServiceLoggingProperty -ServiceType Blob -LoggingOperations Read,Write -PassThru -RetentionDays 10 -Version 1.0 -``` - -This command modifies version 1.0 logging for blob storage to include read and write operations. -Azure Storage service logging retains entries for 10 days. -Because this command specifies the *PassThru* parameter, the command displays the modified logging properties. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoggingOperations -Specifies an array of Azure Storage service operations. -Azure Storage services logs the operations that this parameter specifies. -The acceptable values for this parameter are: -- None -- Read -- Write -- Delete -- All - -```yaml -Type: Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingOperations[] -Parameter Sets: (All) -Aliases: -Accepted values: None, Read, Write, Delete, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the updated logging properties. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Specifies the number of days that the Azure Storage service retains logged information. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet modifies the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the Azure Storage service logging. -The default value is 1.0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.LoggingProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageServiceLoggingProperty](./Get-AzureStorageServiceLoggingProperty.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md deleted file mode 100644 index 5fbd7ca15c..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageServiceMetricsProperty.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 5878FAD4-A4BB-4DBF-A1F2-221FD34F0308 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestorageservicemetricsproperty -schema: 2.0.0 ---- - -# Set-AzureStorageServiceMetricsProperty - -## SYNOPSIS -Modifies metrics properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageServiceMetricsProperty [-ServiceType] [-MetricsType] - [-Version ] [-RetentionDays ] [-MetricsLevel ] [-PassThru] - [-Context ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Set-AzureStorageServiceMetricsProperty** cmdlet modifies metrics properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Modify metrics properties for the Blob service -``` -C:\PS>Set-AzureStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -MetricsLevel Service -PassThru -RetentionDays 10 -Version 1.0 -``` - -This command modifies version 1.0 metrics for blob storage to a level of Service. -Azure Storage service metrics retains entries for 10 days. -Because this command specifies the *PassThru* parameter, the command displays the modified metrics properties. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsLevel -Specifies the metrics level that Azure Storage uses for the service. -The acceptable values for this parameter are: -- None -- Service -- ServiceAndApi - -```yaml -Type: System.Nullable`1[Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsLevel] -Parameter Sets: (All) -Aliases: -Accepted values: None, Service, ServiceAndApi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricsType -Specifies a metrics type. -This cmldet sets the Azure Storage service metrics type to the value that this parameter specifies. -The acceptable values for this parameter are: Hour and Minute. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Minute - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlets returns the updated metrics properties. -If you do not specify this parameter, this cmdlet does not return a value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDays -Specifies the number of days that the Azure Storage service retains metrics information. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet modifies the metrics properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File -The value of File is not currently supported. - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the Azure Storage metrics. -The default value is 1.0. - -```yaml -Type: System.Nullable`1[System.Double] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageServiceMetricsProperty](./Get-AzureStorageServiceMetricsProperty.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - - diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareQuota.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareQuota.md deleted file mode 100644 index b3fa13f612..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareQuota.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 176294FA-BB08-4A63-AD45-1E6C6D67A5D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragesharequota -schema: 2.0.0 ---- - -# Set-AzureStorageShareQuota - -## SYNOPSIS -Sets the storage capacity for a share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Set-AzureStorageShareQuota [-ShareName] [-Quota] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [] -``` - -### Share -``` -Set-AzureStorageShareQuota [-Share] [-Quota] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageShareQuota** cmdlet sets the storage capacity for a specified share. - -## EXAMPLES - -### Example 1: Set the storage capacity of a share -``` -PS C:\>Set-AzureStorageShareQuota -ShareName "ContosoShare01" -Quota 1024 -``` - -This command sets the storage capacity for a share named ContosoShare01 to 1024 GB. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quota -Specifies the quota value in gigabytes (GB). -See the quota limitation in https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits#azure-files-limits. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Specifies a **CloudFileShare** object to represent the share for which this cmdlets sets a quota. -To obtain a **CloudFileShare** object, use the Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: Share -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the file share for which to set a quota. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameters: Share (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Storage.File.FileShareProperties - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFileContent](./Get-AzureStorageFileContent.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md deleted file mode 100644 index baa0163e9d..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageShareStoredAccessPolicy.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C21CC2FA-017E-492E-96E7-B37829917FAF -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragesharestoredaccesspolicy -schema: 2.0.0 ---- - -# Set-AzureStorageShareStoredAccessPolicy - -## SYNOPSIS -Updates a stored access policy on a Storage share. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageShareStoredAccessPolicy [-ShareName] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AzureStorageShareStoredAccessPolicy** cmdlet updates stored access policy on an Azure Storage share. - -## EXAMPLES - -### Example 1: Update a stored access policy in Storage share -``` -PS C:\>Set-AzureStorageShareStoredAccessPolicy -ShareName "ContosoShare" -Policy "GeneralPolicy" -Permission "rwdl" -``` - -This command updates a stored access policy that has full permission in a share. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy becomes invalid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that this cmdlet clears the **ExpiryTime** property in the stored access policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that this cmdlet clears the **StartTime** property in the stored access policy. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the share or files under it. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies a name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of the Storage share. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageShareStoredAccessPolicy](./Get-AzureStorageShareStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageShareStoredAccessPolicy](./New-AzureStorageShareStoredAccessPolicy.md) - -[Remove-AzureStorageShareStoredAccessPolicy](./Remove-AzureStorageShareStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md b/azurermps-2.5.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md deleted file mode 100644 index 693254da5f..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Set-AzureStorageTableStoredAccessPolicy.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: FF2BFE34-4A12-49F9-9BE5-4084A36BC272 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/set-azurestoragetablestoredaccesspolicy -schema: 2.0.0 ---- - -# Set-AzureStorageTableStoredAccessPolicy - -## SYNOPSIS -Sets the stored access policy for an Azure storage table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureStorageTableStoredAccessPolicy [-Table] [-Policy] [-Permission ] - [-StartTime ] [-ExpiryTime ] [-NoStartTime] [-NoExpiryTime] [-Context ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzureStorageTableStoredAccessPolicy** cmdlet set the stored access policy for an Azure storage table. - -## EXAMPLES - -### Example 1: Set a stored access policy in table with full permission -``` -PS C:\>Set-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy08" -Permission raud -``` - -This command sets an access policy named Policy08 for storage table named MyTable. - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 time at which the stored access policy expires. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoExpiryTime -Indicates that the access policy has no expiration date. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStartTime -Indicates that the start time is set to $Null. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Specifies permissions in the stored access policy to access the storage table. -It is important to note that this is a string, like `rwd` (for Read, Write and Delete). - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the name for the stored access policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the time at which the stored access policy becomes valid. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Table -Specifies the Azure storage table name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: N, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageTableStoredAccessPolicy](./Get-AzureStorageTableStoredAccessPolicy.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[New-AzureStorageTableStoredAccessPolicy](./New-AzureStorageTableStoredAccessPolicy.md) - -[Remove-AzureStorageTableStoredAccessPolicy](./Remove-AzureStorageTableStoredAccessPolicy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobCopy.md b/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobCopy.md deleted file mode 100644 index 2581f1a094..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobCopy.md +++ /dev/null @@ -1,572 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 54585346-04E2-4FB4-B5FD-833A85C46ACB -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestorageblobcopy -schema: 2.0.0 ---- - -# Start-AzureStorageBlobCopy - -## SYNOPSIS -Starts to copy a blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName (Default) -``` -Start-AzureStorageBlobCopy [-SrcBlob] -SrcContainer -DestContainer - [-DestBlob ] [-PremiumPageBlobTier ] [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstance -``` -Start-AzureStorageBlobCopy -CloudBlob -DestContainer [-DestBlob ] - [-PremiumPageBlobTier ] [-Context ] [-DestContext ] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobInstanceToBlobInstance -``` -Start-AzureStorageBlobCopy -CloudBlob -DestCloudBlob - [-PremiumPageBlobTier ] [-Context ] [-DestContext ] - [-Force] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerInstance -``` -Start-AzureStorageBlobCopy -CloudBlobContainer [-SrcBlob] -DestContainer - [-DestBlob ] [-PremiumPageBlobTier ] [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### ShareName -``` -Start-AzureStorageBlobCopy -SrcShareName -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareInstance -``` -Start-AzureStorageBlobCopy -SrcShare -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### DirInstance -``` -Start-AzureStorageBlobCopy -SrcDir -SrcFilePath -DestContainer - [-DestBlob ] [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### FileInstance -``` -Start-AzureStorageBlobCopy -SrcFile -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToBlobInstance -``` -Start-AzureStorageBlobCopy -SrcFile -DestCloudBlob [-Context ] - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriPipeline -``` -Start-AzureStorageBlobCopy -AbsoluteUri -DestContainer -DestBlob - [-Context ] [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Start-AzureStorageBlobCopy** cmdlet starts to copy a blob. - -## EXAMPLES - -### Example 1: Copy a named blob -``` -C:\PS>Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -SrcContainer "ContosoUploads" -``` - -This command starts the copy operation of the blob named ContosoPlanning2015 from the container named ContosoUploads to the container named ContosoArchives. - -### Example 2: Get a container to specify blobs to copy -``` -C:\PS>Get-AzureStorageContainer -Name "ContosoUploads" | Start-AzureStorageBlobCopy -SrcBlob "ContosoPlanning2015" -DestContainer "ContosoArchives" -``` - -This command gets the container named ContosoUploads, by using the **Get-AzureStorageContainer** cmdlet, and then passes the container to the current cmdlet by using the pipeline operator. -That cmdlet starts the copy operation of the blob named ContosoPlanning2015. -The previous cmdlet provides the source container. -The *DestContainer* parameter specifies ContosoArchives as the destination container. - -### Example 3: Get all blobs in a container and copy them -``` -C:\PS>Get-AzureStorageBlob -Container "ContosoUploads" | Start-AzureStorageBlobCopy -DestContainer "ContosoArchives" -``` - -This command gets the blobs in the container named ContosoUploads, by using the **Get-AzureStorageBlob** cmdlet, and then passes the results to the current cmdlet by using the pipeline operator. -That cmdlet starts the copy operation of the blobs to the container named ContosoArchives. - -### Example 4: Copy a blob specified as an object -``` -C:\PS>$SrcBlob = Get-AzureStorageBlob -Container "ContosoUploads" -Blob "ContosoPlanning2015" -C:\PS> $DestBlob = Get-AzureStorageBlob -Container "ContosoArchives" -Blob "ContosoPlanning2015Archived" -C:\PS> Start-AzureStorageBlobCopy -ICloudBlob $SrcBlob.ICloudBlob -DestICloudBlob $DestBlob.ICloudBlob -``` - -The first command gets the blob named ContosoPlanning2015 in the container named ContosoUploads. -The command stores that object in the $SrcBlob variable. -The second command gets the blob named ContosoPlanning2015Archived in the container named ContosoArchives. -The command stores that object in the $DestBlob variable. -The last command starts the copy operation from the source container to the destination container. -The command uses standard dot notation to specify the **ICloudBlob** objects for the $SrcBlob and $DestBlob blobs. - -### Example 5: Copy a blob from a URI -``` -C:\PS>$Context = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral ends with == >" -C:\PS> Start-AzureStorageBlobCopy -AbsoluteUri "http://www.contosointernal.com/planning" -DestContainer "ContosoArchive" -DestBlob "ContosoPlanning2015" -DestContext $Context -``` - -This command creates a context for the account named ContosoGeneral that uses the specified key, and then stores that key in the $Context variable. -The second command copies the file from the specified URI to the blob named ContosoPlanning in the container named ContosoArchive. -The command starts the copy operation in the context stored in $Context. - -## PARAMETERS - -### -AbsoluteUri -Specifies the absolute URI of a file to copy to an Azure Storage blob. - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: SrcUri, SourceUri - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstance, BlobInstanceToBlobInstance -Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -This cmdlet copies a blob from the container that this parameter specifies. -To obtain a **CloudBlobContainer** object, use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: SourceCloudBlobContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, FileInstanceToBlobInstance -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UriPipeline -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestBlob -Specifies the name of the destination blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, BlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance -Aliases: DestinationBlob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: DestinationBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestCloudBlob -Specifies a destination **CloudBlob** object - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstanceToBlobInstance, FileInstanceToBlobInstance -Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContainer -Specifies the name of the destination container. - -```yaml -Type: System.String -Parameter Sets: ContainerName, BlobInstance, ContainerInstance, ShareName, ShareInstance, DirInstance, FileInstance, UriPipeline -Aliases: DestinationContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: DestinationContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet overwrites the destination blob without prompting you for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PremiumPageBlobTier -Premium Page Blob Tier - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.PremiumPageBlobTier -Parameter Sets: ContainerName, BlobInstance, BlobInstanceToBlobInstance, ContainerInstance -Aliases: -Accepted values: Unknown, P4, P6, P10, P20, P30, P40, P50, P60 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Specifies the name of the source blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance -Aliases: SourceBlob - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Specifies the name of the source container. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: SourceContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcDir -Specifies a **CloudFileDirectory** object from Azure Storage Client library. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileDirectory -Parameter Sets: DirInstance -Aliases: SourceDir - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcFile -Specifes a **CloudFile** object from Azure Storage Client library. -You can create it or use Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileInstance, FileInstanceToBlobInstance -Aliases: SourceFile - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SrcFilePath -Specifies the source file relative path of source directory or source share. - -```yaml -Type: System.String -Parameter Sets: ShareName, ShareInstance, DirInstance -Aliases: SourceFilePath - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShare -Specifies a **CloudFileShare** object from Azure Storage Client library. -You can create it or use Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: ShareInstance -Aliases: SourceShare - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShareName -Specifies the source share name. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: SourceShareName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: SrcFile (ByValue) - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlobCopyState](./Get-AzureStorageBlobCopyState.md) - -[Stop-AzureStorageBlobCopy](./Stop-AzureStorageBlobCopy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md b/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md deleted file mode 100644 index 2df146d477..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageBlobIncrementalCopy.md +++ /dev/null @@ -1,396 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestorageblobincrementalcopy -schema: 2.0.0 ---- - -# Start-AzureStorageBlobIncrementalCopy - -## SYNOPSIS -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerInstance (Default) -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlobContainer -SrcBlob - -SrcBlobSnapshotTime -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstance -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlob -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceToBlobInstance -``` -Start-AzureStorageBlobIncrementalCopy -CloudBlob -DestCloudBlob - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### ContainerName -``` -Start-AzureStorageBlobIncrementalCopy -SrcBlob -SrcContainer - -SrcBlobSnapshotTime -DestContainer [-DestBlob ] - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriPipeline -``` -Start-AzureStorageBlobIncrementalCopy -AbsoluteUri -DestContainer -DestBlob - [-Context ] [-DestContext ] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Start an Incremental copy operation from a Page blob snapshot to the specified destination Page blob. -See more details of the feature in https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/incremental-copy-blob. - -## EXAMPLES - -### Example 1: Start Incremental Copy Operation by blob name and snapshot time -``` -PS C:\>Start-AzureStorageBlobIncrementalCopy -SrcContainer container1 -SrcBlob blob1 -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -DestBlob blob2 -``` - -This command start Incremental Copy Operation by blob name and snapshot time - -### Example 2: Start Incremental copy operation using source uri -``` -PS C:\>Start-AzureStorageBlobIncrementalCopy -AbsoluteUri "http://www.somesite.com/somefile?snapshot=2017-04-07T10:05:40.2126635Z" -DestContainer container -DestBlob blob -DestContext $context -``` - -This command start Incremental Copy Operation using source uri - -### Example 3: Start Incremental copy operation using container pipeline from GetAzureStorageContainer -``` -PS C:\>Get-AzureStorageContainer -Container container1 | Start-AzureStorageBlobIncrementalCopy -SrcBlob blob -SrcBlobSnapshotTime "04/07/2017 09:55:36.1190229 AM +00:00" -DestContainer container2 -``` - -This command start Incremental Copy Operation using container pipeline from GetAzureStorageContainer - -### Example 4: start Incremental copy operation from CloudPageBlob object to destination blob with blob name -``` -PS C:\>$srcBlobSnapshot = Get-AzureStorageBlob -Container container1 -prefix blob1| ?{$_.ICloudBlob.IsSnapshot})[0] -PS C:\>Start-AzureStorageBlobIncrementalCopy -CloudBlob $srcBlobSnapshot.ICloudBlob -DestContainer container2 -DestBlob blob2 -``` - -This command start Incremental Copy Operation from CloudPageBlob object to destination blob with blob name - -## PARAMETERS - -### -AbsoluteUri -Absolute Uri to the source. Be noted that the credential should be provided in the Uri, if the source requires any. - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: SrcUri, SourceUri - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -The client side maximum execution time for each request in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -CloudBlob object from Azure Storage Client library. You can create it or use Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob -Parameter Sets: BlobInstance, BlobInstanceToBlobInstance -Aliases: SrcICloudBlob, SrcCloudBlob, ICloudBlob, SourceICloudBlob, SourceCloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -CloudBlobContainer object from Azure Storage Client library. You can create it or use Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: SourceCloudBlobContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -The total amount of concurrent async tasks. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Source Azure Storage Context. You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerInstance, BlobInstance, BlobInstanceToBlobInstance, ContainerName -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UriPipeline -Aliases: SrcContext, SourceContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestBlob -Destination blob name - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, BlobInstance, ContainerName -Aliases: DestinationBlob - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UriPipeline -Aliases: DestinationBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestCloudBlob -Destination CloudBlob object - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob -Parameter Sets: BlobInstanceToBlobInstance -Aliases: DestICloudBlob, DestinationCloudBlob, DestinationICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContainer -Destination container name - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, BlobInstance, ContainerName, UriPipeline -Aliases: DestinationContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Destination Azure Storage Context. You can create it by New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: DestinationContext - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -The server time out for each request in seconds. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Source page blob name. - -```yaml -Type: System.String -Parameter Sets: ContainerInstance, ContainerName -Aliases: SourceBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlobSnapshotTime -Source page blob snapshot time. - -```yaml -Type: System.Nullable`1[System.DateTimeOffset] -Parameter Sets: ContainerInstance, ContainerName -Aliases: SourceBlobSnapshotTime - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Source Container name - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: SourceContainer - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudPageBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### System.String - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageFileCopy.md b/azurermps-2.5.0/Azure.Storage/Start-AzureStorageFileCopy.md deleted file mode 100644 index 2f60834325..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Start-AzureStorageFileCopy.md +++ /dev/null @@ -1,483 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: A96A1A67-6C9C-499F-9935-B90F7ACEB50E -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/start-azurestoragefilecopy -schema: 2.0.0 ---- - -# Start-AzureStorageFileCopy - -## SYNOPSIS -Starts to copy a source file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ContainerName -``` -Start-AzureStorageFileCopy -SrcBlobName -SrcContainerName -DestShareName - -DestFilePath [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerInstance -``` -Start-AzureStorageFileCopy -SrcBlobName -SrcContainer -DestShareName - -DestFilePath [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceFilePath -``` -Start-AzureStorageFileCopy -SrcBlob -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### BlobInstanceFileInstance -``` -Start-AzureStorageFileCopy -SrcBlob -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareName -``` -Start-AzureStorageFileCopy -SrcFilePath -SrcShareName -DestShareName - -DestFilePath [-Context ] [-DestContext ] [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ShareInstance -``` -Start-AzureStorageFileCopy -SrcFilePath -SrcShare -DestShareName - -DestFilePath [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToFilePath -``` -Start-AzureStorageFileCopy -SrcFile -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### FileInstanceToFileInstance -``` -Start-AzureStorageFileCopy -SrcFile -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### UriToFilePath -``` -Start-AzureStorageFileCopy -AbsoluteUri -DestShareName -DestFilePath - [-DestContext ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -### UriToFileInstance -``` -Start-AzureStorageFileCopy -AbsoluteUri -DestFile [-Force] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Start-AzureStorageFileCopy** cmdlet starts to copy a source file to a destination file. - -## EXAMPLES - -### Example 1: Start copy operation from file to file by using share name and file name -``` -PS C:\>Start-AzureStorageFileCopy -SrcShareName "ContosoShare01" -SrcFilePath "FilePath01" -DestShareName "ContosoShare02" -DestFilePath "FilePath02" -``` - -This command starts a copy operation from file to file. -The command specifies share name and file name - -### Example 2: Start copy operation from blob to file by using container name and blob name -``` -PS C:\>Start-AzureStorageFileCopy -SrcContainerName "ContosoContainer01" -SrcBlobName "ContosoBlob01" -DestShareName "ContosoShare" -DestFilePath "FilePath02" -``` - -This command starts a copy operation from blob to file. -The command specifies container name and blob name - -## PARAMETERS - -### -AbsoluteUri -Specifies the URI of the source file. -If the source location requires a credential, you must provide one. - -```yaml -Type: System.String -Parameter Sets: UriToFilePath, UriToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure Storage context. -To obtain a context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, ShareName -Aliases: SrcContext - -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. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestContext -Specifies the Azure Storage context of the destination. -To obtain a context, use **New-AzureStorageContext**. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestFile -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: BlobInstanceFileInstance, FileInstanceToFileInstance, UriToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestFilePath -Specifies the path of the destination file relative to the destination share. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestShareName -Specifies the name of the destination share. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance, BlobInstanceFilePath, ShareName, ShareInstance, FileInstanceToFilePath, UriToFilePath -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcBlob -Specifies a **CloudBlob** object. -You can create a cloud blob or obtain one by using the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobInstanceFilePath, BlobInstanceFileInstance -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SrcBlobName -Specifies the name of the source blob. - -```yaml -Type: System.String -Parameter Sets: ContainerName, ContainerInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainer -Specifies a cloud blob container object. -You can create cloud blob container object or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcContainerName -Specifies the name of the source container. - -```yaml -Type: System.String -Parameter Sets: ContainerName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcFile -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using **Get-AzureStorageFile**. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: FileInstanceToFilePath, FileInstanceToFileInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SrcFilePath -Specifies the path of the source file relative to the source directory or source share. - -```yaml -Type: System.String -Parameter Sets: ShareName, ShareInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShare -Specifies a cloud file share object. -You can create a cloud file share or obtain one by using the Get-AzureStorageShare cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFileShare -Parameter Sets: ShareInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SrcShareName -Specifies the name of the source share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: SrcFile (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageShare](./Get-AzureStorageShare.md) - -[Get-AzureStorageFileCopyState](./Get-AzureStorageFileCopyState.md) - -[Stop-AzureStorageFileCopy](./Stop-AzureStorageFileCopy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageBlobCopy.md b/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageBlobCopy.md deleted file mode 100644 index 10921b69fc..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageBlobCopy.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: C274DFBD-6C93-4043-AF93-DAF7BEA1F11F -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/stop-azurestorageblobcopy -schema: 2.0.0 ---- - -# Stop-AzureStorageBlobCopy - -## SYNOPSIS -Stops a copy operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NamePipeline (Default) -``` -Stop-AzureStorageBlobCopy [-Blob] [-Container] [-Force] [-CopyId ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### BlobPipeline -``` -Stop-AzureStorageBlobCopy -CloudBlob [-Force] [-CopyId ] [-Context ] - [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### ContainerPipeline -``` -Stop-AzureStorageBlobCopy -CloudBlobContainer [-Blob] [-Force] [-CopyId ] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Stop-AzureStorageBlobCopy** cmdlet stops a copy operation to the specified destination blob. - -## EXAMPLES - -### Example 1: Stop copy operation by name -``` -PS C:\>Stop-AzureStorageBlobCopy -Container "ContainerName" -Blob "BlobName" -CopyId "CopyID" -``` - -This command stops the copy operation by name. - -### Example 2: Stop copy operation by using the pipeline -``` -PS C:\>Get-AzureStorageContainer container* | Stop-AzureStorageBlobCopy -Blob "BlobName" -``` - -This command stops the copy operation by passing the container on the pipeline from **Get-AzureStorageContainer**. - -### Example 3: Stop copy operation by using the pipeline and Get-AzureStorageBlob -``` -PS C:\>Get-AzureStorageBlob -Container "ContainerName" | Stop-AzureStorageBlobCopy -Force -``` - -This example stops the copy operation by passing the container on the pipeline from the Get-AzureStorageBlob cmdlet. - -## PARAMETERS - -### -Blob -Specifies the name of the blob. - -```yaml -Type: System.String -Parameter Sets: NamePipeline, ContainerPipeline -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloudBlob -Specifies a **CloudBlob** object from Azure Storage Client library. -To obtain a **CloudBlob** object, use the Get-AzureStorageBlob cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlob -Parameter Sets: BlobPipeline -Aliases: ICloudBlob - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CloudBlobContainer -Specifies a **CloudBlobContainer** object from the Azure Storage Client library. -You can create the object or use the Get-AzureStorageContainer cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer -Parameter Sets: ContainerPipeline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Specifies the name of the container. - -```yaml -Type: System.String -Parameter Sets: NamePipeline -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies the Azure storage context. -You can create the context by using the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CopyId -Specifies the copy ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Stops the current copy task on the specified blob without prompting for confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the service side time-out interval, in seconds, for a request. -If the specified interval elapses before the service processes the request, the storage service returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlob - -### Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Common.Storage.ResourceModel.AzureStorageBlob - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageBlob](./Get-AzureStorageBlob.md) - -[Get-AzureStorageContainer](./Get-AzureStorageContainer.md) - -[Start-AzureStorageBlobCopy](./Start-AzureStorageBlobCopy.md) - -[Get-AzureStorageBlobCopyState](./Get-AzureStorageBlobCopyState.md) diff --git a/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageFileCopy.md b/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageFileCopy.md deleted file mode 100644 index fe03b7bf65..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Stop-AzureStorageFileCopy.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -ms.assetid: 3AC3F8DE-E25D-41AE-9083-5C459A4C8CD0 -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/stop-azurestoragefilecopy -schema: 2.0.0 ---- - -# Stop-AzureStorageFileCopy - -## SYNOPSIS -Stops a copy operation to the specified destination file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ShareName -``` -Stop-AzureStorageFileCopy [-ShareName] [-FilePath] [-CopyId ] [-Force] - [-Context ] [-ServerTimeoutPerRequest ] [-ClientTimeoutPerRequest ] - [-DefaultProfile ] [-ConcurrentTaskCount ] [-WhatIf] [-Confirm] - [] -``` - -### File -``` -Stop-AzureStorageFileCopy [-File] [-CopyId ] [-Force] [-ServerTimeoutPerRequest ] - [-ClientTimeoutPerRequest ] [-DefaultProfile ] [-ConcurrentTaskCount ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Stop-AzureStorageFileCopy** cmdlet stops copying a file to a destination file. - -## EXAMPLES - -### Example 1: Stop a copy operation -``` -PS C:\>Stop-AzureStorageFileCopy -ShareName "ContosoShare" -FilePath "FilePath" -CopyId "CopyId" -``` - -This command stops copying a file that has the specified name. - -## PARAMETERS - -### -ClientTimeoutPerRequest -Specifies the client-side time-out interval, in seconds, for one service request. -If the previous call fails in the specified interval, this cmdlet retries the request. -If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentTaskCount -Specifies the maximum concurrent network calls. -You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. -The specified value is an absolute count and is not multiplied by the core count. -This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. -The default value is 10. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: ShareName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CopyId -Specifies the ID of the copy operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies a **CloudFile** object. -You can create a cloud file or obtain one by using the Get-AzureStorageFile cmdlet. - -```yaml -Type: Microsoft.WindowsAzure.Storage.File.CloudFile -Parameter Sets: File -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FilePath -Specifies the path of a file. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerTimeoutPerRequest -Specifies the length of the time-out period for the server part of a request. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShareName -Specifies the name of a share. - -```yaml -Type: System.String -Parameter Sets: ShareName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.WindowsAzure.Storage.File.CloudFile -Parameters: File (ByValue) - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureStorageFile](./Get-AzureStorageFile.md) - -[Get-AzureStorageFileCopyState](./Get-AzureStorageFileCopyState.md) - -[New-AzureStorageContext](./New-AzureStorageContext.md) - -[Start-AzureStorageFileCopy](./Start-AzureStorageFileCopy.md) diff --git a/azurermps-2.5.0/Azure.Storage/Update-AzureStorageServiceProperty.md b/azurermps-2.5.0/Azure.Storage/Update-AzureStorageServiceProperty.md deleted file mode 100644 index 84de377257..0000000000 --- a/azurermps-2.5.0/Azure.Storage/Update-AzureStorageServiceProperty.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml -Module Name: Azure.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azure.storage/update-azurestorageserviceproperty -schema: 2.0.0 ---- - -# Update-AzureStorageServiceProperty - -## SYNOPSIS -Modifies the properties for the Azure Storage service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureStorageServiceProperty [-ServiceType] [-DefaultServiceVersion ] - [-PassThru] [-Context ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Update-AzureStorageServiceProperty** cmdlet modifies the properties for the Azure Storage service. - -## EXAMPLES - -### Example 1: Set Blob Service DefaultServiceVersion to 2017-04-17 -``` -C:\PS>Update-AzureStorageServiceProperty -ServiceType Blob -DefaultServiceVersion 2017-04-17 -``` - -This command Set the DefaultServiceVersion of Blob Service to 2017-04-17 - -## PARAMETERS - -### -Context -Specifies an Azure storage context. -To obtain a storage context, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultServiceVersion -DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions. -See more details in https://docs.microsoft.com/en-us/rest/api/storageservices/versioning-for-the-azure-storage-services - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Display ServiceProperties - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceType -Specifies the storage service type. -This cmdlet gets the logging properties for the service type that this parameter specifies. -The acceptable values for this parameter are: -- Blob -- Table -- Queue -- File - -```yaml -Type: Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType -Parameter Sets: (All) -Aliases: -Accepted values: Blob, Table, Queue, File - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -## OUTPUTS - -### Microsoft.WindowsAzure.Commands.Storage.Model.ResourceModel.PSSeriviceProperties - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRMVhd.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRMVhd.md deleted file mode 100644 index f2c67a6339..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRMVhd.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D08DAA8B-B7BF-4167-AB16-F2723985A0B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvhd -schema: 2.0.0 ---- - -# Add-AzureRmVhd - -## SYNOPSIS -Uploads a virtual hard disk from an on-premises virtual machine to a blob in a cloud storage account in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVhd [[-ResourceGroupName] ] [-Destination] [-LocalFilePath] - [[-NumberOfUploaderThreads] ] [[-BaseImageUriToPatch] ] [-OverWrite] [-AsJob] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmVhd** cmdlet uploads on-premises virtual hard disks, in .vhd file format, to a blob storage account as fixed virtual hard disks. -You can configure the number of uploader threads that will be used or overwrite an existing blob in the specified destination URI. -Also supported is the ability to upload a patched version of an on-premises .vhd file. -When a base virtual hard disk has already been uploaded, you can upload differencing disks that use the base image as the parent. -Shared access signature (SAS) URI is supported also. - -## EXAMPLES - -### Example 1: Add a VHD file -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -``` - -This command adds a .vhd file to a storage account. - -### Example 2: Add a VHD file and overwrite the destination -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -``` - -This command adds a .vhd file to a storage account. -The command overwrites an existing file. - -### Example 3: Add a VHD file and specify the number of threads -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfUploaderThreads 32 -``` - -This command adds a .vhd file to a storage account. -The command specifies the number of threads to use to upload the file. - -### Example 4: Add a VHD file and specify the SAS URI -``` -PS C:\> Add-AzureRmVhd -Destination "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd?st=2013-01 -09T22%3A15%3A49Z&se=2013-01-09T23%3A10%3A49Z&sr=b&sp=w&sig=13T9Ow%2FRJAMmhfO%2FaP3HhKKJ6AY093SmveO SIV4%2FR7w%3D" -LocalFilePath "C:\vhd\win7baseimage.vhd" -``` - -This command adds a .vhd file to a storage account and specifies the SAS URI. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseImageUriToPatch -Specifies the URI to a base image blob in Azure Blob Storage. -An SAS can be specified as the value for this parameter. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: bs - -Required: False -Position: 4 -Default value: None -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 -``` - -### -Destination -Specifies the URI of a blob in Blob Storage. -The parameter supports SAS URI, although patching scenarios destination cannot be an SAS URI. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: dst - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalFilePath -Specifies the path of the local .vhd file. - -```yaml -Type: FileInfo -Parameter Sets: (All) -Aliases: lf - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NumberOfUploaderThreads -Specifies the number of uploader threads to be used when uploading the .vhd file. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: th - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OverWrite -Indicates that this cmdlet overwrites an existing blob in the specified destination URI, if one exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: o - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VhdUploadContext - -## NOTES - -## RELATED LINKS - -[Save-AzureRmVhd](./Save-AzureRmVhd.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md deleted file mode 100644 index 8b77ea6b1c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmContainerServiceAgentPoolProfile.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C3C65F3E-1192-4B57-87DB-5D371C8FF68E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermcontainerserviceagentpoolprofile -schema: 2.0.0 ---- - -# Add-AzureRmContainerServiceAgentPoolProfile - -## SYNOPSIS -Adds a container service agent pool profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmContainerServiceAgentPoolProfile [-ContainerService] [[-Name] ] - [[-Count] ] [[-VmSize] ] [[-DnsPrefix] ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AzureRmContainerServiceAgentPoolProfile** cmdlet adds a container service agent pool profile to a local container service object. - -## EXAMPLES - -### Example 1: Add a profile -``` -PS C:\> Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -``` - -This command adds a container service agent pool profile to the local container service object. - -## PARAMETERS - -### -ContainerService -Specifies the container service object to which this cmdlet adds an agent pool profile. -To obtain a **ContainerService** object, use the [New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) cmdlet. - -```yaml -Type: PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Count -Specifies the number of agents that host containers. -The acceptable values for this parameter are: integers from 1 to 100. -The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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 -``` - -### -DnsPrefix -Specifies the DNS prefix that this cmdlet uses to create the fully qualified domain name for this agent pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the agent pool profile. -This value must be unique in the context of the subscription and resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSize -Specifies the size of the virtual machines for the agents. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ContainerService -Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) - -[Remove-AzureRmContainerServiceAgentPoolProfile](./Remove-AzureRmContainerServiceAgentPoolProfile.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmImageDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmImageDataDisk.md deleted file mode 100644 index f6f03096b6..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmImageDataDisk.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermimagedatadisk -schema: 2.0.0 ---- - -# Add-AzureRmImageDataDisk - -## SYNOPSIS -Adds a data disk to an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmImageDataDisk [-Image] [[-Lun] ] [[-BlobUri] ] [[-Caching] ] - [-DiskSizeGB ] [-StorageAccountType ] [-SnapshotId ] - [-ManagedDiskId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AzureRmImageDataDisk** cmdlet adds a data disk to an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. - -The next three commands assign paths of operating system disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. - -The next three commands each adds an operating system disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. - -The final command creates an image named ImageName01 in resource group ResourceGroup01. - -## PARAMETERS - -### -BlobUri -Specifies the link, as a URI, of the blob. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Caching -Specifies the caching mode of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -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 -``` - -### -DiskSizeGB -Specifies the size of the disk in Gigabytes (GB). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the ID of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The Storage Account type of the data image disk - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Image -System.Int32 -System.String -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Image - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMAdditionalUnattendContent.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMAdditionalUnattendContent.md deleted file mode 100644 index 3a665b936d..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMAdditionalUnattendContent.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 50B64FFE-8277-4DAA-805A-271123B35355 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmadditionalunattendcontent -schema: 2.0.0 ---- - -# Add-AzureRmVMAdditionalUnattendContent - -## SYNOPSIS -Adds information to the unattended Windows Setup answer file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMAdditionalUnattendContent [-VM] [[-Content] ] - [[-SettingName] ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The **Add-AzureRmVMAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. -Specify additional base 64 encoded .xml formatted information that this cmdlet adds to the unattend.xml file. - -## EXAMPLES - -### Example 1: Add content to unattend.xml -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $Credential = Get-Credential -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential -PS C:\> $AucContent = "" + "Password" + "true</PlainText></AdministratorPassword></UserAccounts>"; -PS C:\> $VirtualMachine = Add-AzureRmVMAdditionalUnattendContent -VM $VirtualMachine -Content $AucContent -SettingName "AutoLogon" -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. - -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. - -The third command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. -The command prompts you for a user name and password. -For more information, type `Get-Help Get-Credential`. - -The fourth command uses the **Set-AzureRmVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. - -The fifth command assigns content to the $AucContent variable. -The content includes a password. - -The final command adds the content stored in $AucContent to the unattend.xml file. - -## PARAMETERS - -### -Content -Specifies base 64 encoded XML formatted content. -This cmdlet adds the content to the unattend.xml file. -The XML content must be less than 4 KB and must include the root element for the setting or feature that this cmdlet inserts. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -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 -``` - -### -SettingName -Specifies the name of the setting to which the content applies. -The acceptable values for this parameter are: - -- FirstLogonCommands -- AutoLogon - -```yaml -Type: SettingNames -Parameter Sets: (All) -Aliases: -Accepted values: AutoLogon, FirstLogonCommands - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -Create a virtual machine object by using the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMDataDisk.md deleted file mode 100644 index 93d896d243..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMDataDisk.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 169E6694-82CD-4FCB-AB3D-E8A74001B8DB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmdatadisk -schema: 2.0.0 ---- - -# Add-AzureRmVMDataDisk - -## SYNOPSIS -Adds a data disk to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-DiskSizeInGB] <Int32>] [-Lun] <Int32> [-CreateOption] <DiskCreateOptionTypes> - [[-SourceImageUri] <String>] [[-ManagedDiskId] <String>] [[-StorageAccountType] <StorageAccountTypes>] - [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMDataDisk** cmdlet adds a data disk to a virtual machine. -You can add a data disk when you create a virtual machine, or you can add a data disk to an existing virtual machine. - -## EXAMPLES - -### Example 1: Add data disks to a new virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataDiskVhdUri01 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $DataDiskVhdUri02 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> $DataDiskVhdUri03 = "https://contoso.blob.core.windows.net/test/data3.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk1' -Caching 'ReadOnly' -DiskSizeInGB 10 -Lun 0 -VhdUri $DataDiskVhdUri01 -CreateOption Empty -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk2' -Caching 'ReadOnly' -DiskSizeInGB 11 -Lun 1 -VhdUri $DataDiskVhdUri02 -CreateOption Empty -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name 'DataDisk3' -Caching 'ReadOnly' -DiskSizeInGB 12 -Lun 2 -VhdUri $DataDiskVhdUri03 -CreateOption Empty -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. - -The next three commands assign paths of three data disks to the $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03 variables. -This approach is only for readability of the following commands. - -The final three commands each adds a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk, and other properties of the disk. -The URI of each disk is stored in $DataDiskVhdUri01, $DataDiskVhdUri02, and $DataDiskVhdUri03. - -### Example 2: Add a data disk to an existing virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "disk1" -VhdUri "https://contoso.blob.core.windows.net/vhds/diskstandard03.vhd" -LUN 0 -Caching ReadOnly -DiskSizeinGB 1 -CreateOption Empty -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. - -The second command adds a data disk to the virtual machine stored in $VirtualMachine. - -The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. - -### Example 3: Add a data disk to a new virtual machine from a generalized user image -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataImageUri = "https://contoso.blob.core.windows.net/system/Microsoft.Compute/Images/captured/dataimage.vhd" -PS C:\> $DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "disk1" -SourceImageUri $DataImageUri -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption FromImage -``` - -The first command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. - -The next two commands assign paths for the data image and data disks to the $DataImageUri and $DataDiskUri variables respectively. -This approach is used to improve the readability of the following commands. - -The final commands adds a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk and other properties of the disk. - -### Example 4: Add data disks to a new virtual machine from a specialized user image -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> $DataDiskUri = "https://contoso.blob.core.windows.net/test/datadisk.vhd" -PS C:\> $VirtualMachine = Add-AzureRmVMDataDisk -VM $VirtualMachine -Name "dd1" -VhdUri $DataDiskUri -Lun 0 -DiskSizeinGB 10 -CreateOption Attach -``` - -The first command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. - -The next commands assigns paths of the data disk to the $DataDiskUri variable. -This approach is used to improve the readability of the following commands. - -The final command add a data disk to the virtual machine stored in $VirtualMachine. -The command specifies the name and location for the disk, and other properties of the disk. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the disk. -The acceptable values for this parameter are: - -- ReadOnly -- ReadWrite -- None - -The default value is ReadWrite. -Changing this value causes the virtual machine to restart. - -This setting affects the consistency and performance of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. -The acceptable values for this parameter are: - -- Attach. -Specify this option to create a virtual machine from a specialized disk. -When you specify this option, do not specify the *SourceImageUri* parameter. -The *VhdUri* is all that is needed in order to tell the Azure platform the location of the virtual hard disk (VHD) to attach as a data disk to the virtual machine. -- Empty. -Specify this to create an empty data disk. -- FromImage. -Specify this option to create a virtual machine from a generalized image or disk. -When you specify this option, you must specify the *SourceImageUri* parameter also in order to tell the Azure platform the location of the VHD to attach as a data disk. -The *VhdUri* parameter is used as the location identifying where the data disk VHD will be stored when it is used by the virtual machine. - -```yaml -Type: DiskCreateOptionTypes -Parameter Sets: (All) -Aliases: -Accepted values: FromImage, Empty, Attach - -Required: True -Position: 6 -Default value: None -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 -``` - -### -DiskSizeInGB -Specifies the size, in gigabytes, of an empty disk to attach to a virtual machine. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) for a data disk. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data disk to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceImageUri -Specifies the source URI of the disk that this cmdlet attaches. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SourceImage - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of managed disk. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VhdUri -Specifies the Uniform Resource Identifier (URI) for the virtual hard disk (VHD) file to create when a platform image or user image is used. -This cmdlet copies the image binary large object (blob) to this location. -This is the location from which to start the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object to which to add a data disk. -You can use the **Get-AzureRmVM** cmdlet to obtain a virtual machine object. -You can use the **New-AzureRmVMConfig** cmdlet to create a virtual machine object. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the data disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDataDisk](./Remove-AzureRmVMDataDisk.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMNetworkInterface.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMNetworkInterface.md deleted file mode 100644 index 71d146e799..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMNetworkInterface.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BF80D456-DAB1-4B51-B50F-A75C2C66A472 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmnetworkinterface -schema: 2.0.0 ---- - -# Add-AzureRmVMNetworkInterface - -## SYNOPSIS -Adds a network interface to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetNicFromNicId (Default) -``` -Add-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> [-Id] <String> [-Primary] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetNicFromNicObject -``` -Add-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> - [-NetworkInterface] <System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMNetworkInterface** cmdlet adds a network interface to a virtual machine. -You can add an interface when you create a virtual machine or add one to an existing virtual machine. - -## EXAMPLES - -### Example 1: Add a network interface to a new virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -PS C:\> Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. - -The second command adds a network interface to the virtual machine stored in $VirtualMachine. - -### Example 2: Add a network interface to an existing virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id "/subscriptions/46fc8ea4-2de6-4179-8ab1-365da4121af4/resourceGroups/contoso/providers/Microsoft.Network/networkInterfaces/sshNIC" -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. - -The second command adds a network interface to the virtual machine stored in $VirtualMachine. - -The final command updates the state of the virtual machine stored in $VirtualMachine in 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 -``` - -### -Id -Specifies the ID of a network interface to add to a virtual machine. -You can use the [Get-AzureRmNetworkInterface](/powershell/module/azurerm.network/get-azurermnetworkinterface) cmdlet to obtain a network interface. - -```yaml -Type: String -Parameter Sets: GetNicFromNicId -Aliases: NicId, NetworkInterfaceId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies the network interface. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Internal.Network.Common.INetworkInterfaceReference] -Parameter Sets: GetNicFromNicObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -Indicates that this cmdlet adds the network interface as the primary interface. - -```yaml -Type: SwitchParameter -Parameter Sets: GetNicFromNicId -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine object to which to add a network interface. -To create a virtual machine, use the **New-AzureRmVMConfig** cmdlet. -To obtain an existing virtual machine, use the **Get-AzureRmVM** cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterface] -Parameter 'NetworkInterface' accepts value of type 'System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterface]' from the pipeline - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSecret.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSecret.md deleted file mode 100644 index dfff91a652..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSecret.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5008F83F-AF3E-47CF-99A3-55129E654128 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsecret -schema: 2.0.0 ---- - -# Add-AzureRmVMSecret - -## SYNOPSIS -Adds a secret to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String>] [[-CertificateStore] <String>] - [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMSecret** cmdlet adds a secret to a virtual machine. -This value lets you add a certificate to the virtual machine. -The secret must be stored in a Key Vault. -For more information about Key Vault, see [What is Azure Key Vault?](https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/). -For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/azurerm.keyvault/) in the Microsoft Developer Network library or the [Set-AzureKeyVaultSecret](/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret) cmdlet. - -## EXAMPLES - -### Example 1: Add a secret to a virtual machine -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $Credential = Get-Credential -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential -PS C:\> $SourceVaultId = "/subscriptions/46f8cea4-2de6-4179-8ab1-365da4211af4/resourceGroups/vault/providers/Microsoft.KeyVault/vaults/keyvault" -PS C:\> $CertificateStore01 = "My" -PS C:\> $CertificateUrl01 = "https://contosovault.vault.azure.net/secrets/514ceb769c984379a7e0230bdd703272" -PS C:\> $VirtualMachine = Add-AzureRmVMSecret -VM $VirtualMachine -SourceVaultId $SourceVaultId -CertificateStore $CertificateStore01 -CertificateUrl $CertificateUrl01 -``` - -The first command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. - -The second command creates a credential object by using the Get-Credential cmdlet, and then stores the result in the $Credential variable. -The command prompts you for a user name and password. -For more information, type `Get-Help Get-Credential`. - -The third command uses the **Set-AzureRmVMOperatingSystem** cmdlet to configure the virtual machine stored in $VirtualMachine. - -The fourth command assigns a source vault ID to the $SourceVaultId variable for later use. -The command assumes that the $SubscriptionId variable has an appropriate value. - -The fifth command assigns a value to the $CertificateStore01 variable for later use. - -The sixth command assigns a URL for a certificate store. - -The seventh command adds a secret to the virtual machine stored in $VirtualMachine. -The SourceVaultId parameter specifies the Key Vault. -The command specifies the name of the certificate store and the URL of the certificate. -You can run the **Add-AzureRmVMSecret** repeatedly to add secrets for other certificates. - -## PARAMETERS - -### -CertificateStore -Specifies the name of a certificate store on the virtual machine that runs the Windows operating system. -This cmdlet adds the certificate to the store that this parameter specifies. -You can only specify this parameter for virtual machines that run the Windows operating system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateUrl -Specifies the URL that points to a Key Vault secret which contains a certificate. - -The certificate is the Base64 encoding of the following JavaScript Object Notation (JSON) object, which is encoded in UTF-8: - -{ -"data": "\<Base64-encoded-file\>", -"dataType": "\<file-format\>", -"password": "\<pfx-file-password\>" -} - - -Currently, dataType accepts only .pfx files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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 -``` - -### -SourceVaultId -Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. -This value also acts as the key for adding multiple certificates. -This means that you can use the same value for *SourceVaultId* when you add multiple certificates from the same Key Vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Id - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -You can use the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet to create a virtual machine object. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSshPublicKey.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSshPublicKey.md deleted file mode 100644 index a34efab4a6..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVMSshPublicKey.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3CE367B1-7685-4046-8E9C-CE680B5AE03F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsshpublickey -schema: 2.0.0 ---- - -# Add-AzureRmVMSshPublicKey - -## SYNOPSIS -Adds the public keys for SSH for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVMSshPublicKey [-VM] <PSVirtualMachine> [[-KeyData] <String>] [[-Path] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVMSshPublicKey** cmdlet adds the public keys that you can use to connect to a virtual machine over Secure Shell (SSH). - -## EXAMPLES - -### Example 1: Add a public key to a virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> $VirtualMachine = Add-AzureRmVMSshPublicKey -VM $VirtualMachine -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. - -The second command adds the public key to the location on VirtualMachine07 that the Path parameter specifies. - -## 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 -``` - -### -KeyData -Specifies a base 64 encoding of a public key. -You can connect to a virtual machine by using SSH or by using the key that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. -If the file already exists, this cmdlet appends the key to the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object that this cmdlet modifies. -To obtain a virtual machine object, use the [Get-AzureRmVM](./Get-AzureRmVM.md) cmdlet. -You can use the [New-AzureRmVMConfig](./New-AzureRmVMConfig.md) cmdlet to create a virtual machine object. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssAdditionalUnattendContent.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssAdditionalUnattendContent.md deleted file mode 100644 index 969f7d7303..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssAdditionalUnattendContent.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9BE2E42C-594B-4B67-866C-BBA3B84AA5FD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssadditionalunattendcontent -schema: 2.0.0 ---- - -# Add-AzureRmVmssAdditionalUnattendContent - -## SYNOPSIS -Adds information to the unattended Windows Setup answer file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssAdditionalUnattendContent [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-PassName] <PassNames>] [[-ComponentName] <ComponentNames>] [[-SettingName] <SettingNames>] - [[-Content] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssAdditionalUnattendContent** cmdlet adds information to the unattended Windows Setup answer file. - -## EXAMPLES - -### Example 1: Add information to the unattended Windows Setup answer file -``` -PS C:\> Add-AzureRmVmssAdditionalUnattendContent -VirtualMachineScaleSet $VMSS -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting -``` - -This command adds information to the unattended Windows Setup answer file. - -## PARAMETERS - -### -ComponentName -Specifies the name of the component to configure with the added content. -The only allowable value is Microsoft-Windows-Shell-Setup. - -```yaml -Type: ComponentNames -Parameter Sets: (All) -Aliases: -Accepted values: MicrosoftWindowsShellSetup - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Content -Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -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 -``` - -### -PassName -Specifies the name of the pass that the content applies to. -The only allowable value is oobeSystem. - -```yaml -Type: PassNames -Parameter Sets: (All) -Aliases: -Accepted values: OobeSystem - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingName -Specifies the name of the setting to which the content applies. -The acceptable values for this parameter are:: - -- FirstLogonCommands -- AutoLogon - -```yaml -Type: SettingNames -Parameter Sets: (All) -Aliases: -Accepted values: AutoLogon, FirstLogonCommands - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the virtual machine **Scale Set** object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDataDisk.md deleted file mode 100644 index 8e26782317..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDataDisk.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssdatadisk -schema: 2.0.0 ---- - -# Add-AzureRmVmssDataDisk - -## SYNOPSIS -Adds a data disk to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] - [[-Lun] <Int32>] [[-Caching] <CachingTypes>] [-WriteAccelerator] [-CreateOption <DiskCreateOptionTypes>] - [-DiskSizeGB <Int32>] [-StorageAccountType <StorageAccountTypes>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssDataDisk** cmdlet adds a data disk to the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1: Add a data disk -``` -PS C:\> $vmss = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -PS C:\> $vmss = Add-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -Lun 0 -Caching 'ReadOnly' -CreateOption Empty -DiskSizeGB 10 -StorageAccountType StandardLRS -``` - -This command adds an empty data disk to the VMSS object. - -## PARAMETERS - -### -Caching -Specifies the caching type of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateOption -Specifies the create option of the disk. - -```yaml -Type: DiskCreateOptionTypes -Parameter Sets: (All) -Aliases: -Accepted values: FromImage, Empty, Attach - -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number of the disk. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of the disk. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the data disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet -System.String -System.Int32 -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.DiskCreateOptionTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.StorageAccountTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDiagnosticsExtension.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDiagnosticsExtension.md deleted file mode 100644 index b8d3ee8692..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssDiagnosticsExtension.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7A1B92F5-C698-4D5E-ACD7-4013F1BC6247 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssdiagnosticsextension -schema: 2.0.0 ---- - -# Add-AzureRmVmssDiagnosticsExtension - -## SYNOPSIS -Adds a diagnostics extension to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <VirtualMachineScaleSet> - [-SettingFilePath] <String> [[-ProtectedSettingFilePath] <String>] [[-Name] <String>] - [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssDiagnosticsExtension** cmdlet adds a diagnostics extension to the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1: Add a diagnostics extension to the VMSS -``` -PS C:\> Add-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -SettingFilePath $publicConfigPath -ProtectedSettingFilePath $privateConfigPath -Name $extName -TypeHandlerVersion $typeVersion -AutoUpgradeMinorVersion $True -Force -``` - -This command adds a diagnostics extension to the VMSS. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettingFilePath -Specifies the path of the private configuration file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingFilePath -Specifies the path of the public configuration file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this VMSS. -To obtain the version, run the [Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) cmdlet with a value of Microsoft.Azure.Diagnostics for the *PublisherName* parameter and IaaSDiagnostics for the *Type* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: VirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) - -[Remove-AzureRmVmssDiagnosticsExtension](./Remove-AzureRmVmssDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssExtension.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssExtension.md deleted file mode 100644 index 126c5d70b2..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssExtension.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7EC166C7-151D-4DA0-9B10-165E735D4F12 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssextension -schema: 2.0.0 ---- - -# Add-AzureRmVmssExtension - -## SYNOPSIS -Adds an extension to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>] - [[-Publisher] <String>] [[-Type] <String>] [[-TypeHandlerVersion] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>] - [-ForceUpdateTag <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssExtension** cmdlet adds an extension to the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add an extension to the VMSS -``` -PS C:\> Add-AzureRmVmssExtension -VirtualMachineScaleSet $VMSS -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True -``` - -This command adds an extension to the VMMS. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether the extension version should be automatically updated to a newer minor version. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -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 -``` - -### -ForceUpdateTag -If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. - -```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 extension that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSetting -Specifies private configuration for the extension, as a string. -This cmdlet encrypts the private configuration. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the name of the extension publisher. -The publisher provides a name when the publisher registers an extension. -This can use the [Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) cmdlet to get the publisher. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Setting -Specifies the public configuration, as a string, for the extension. -This cmdlet does not encrypt public configuration. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the extension type. -You can use the [Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) cmdlet to get the extension type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -You can use the [Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) cmdlet to get the version of the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVmssExtension](./Remove-AzureRmVmssExtension.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md deleted file mode 100644 index 249d2ed466..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssNetworkInterfaceConfiguration.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BAC2FA68-1D82-411D-A853-FD4EE525B533 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmssnetworkinterfaceconfiguration -schema: 2.0.0 ---- - -# Add-AzureRmVmssNetworkInterfaceConfiguration - -## SYNOPSIS -Adds a network interface configuration to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-Name] <String>] [[-Primary] <Boolean>] [[-Id] <String>] - [[-IpConfiguration] <VirtualMachineScaleSetIPConfiguration[]>] [-EnableAcceleratedNetworking] - [-EnableIPForwarding] [-NetworkSecurityGroupId <String>] [-DnsSettingsDnsServer <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssNetworkInterfaceConfiguration** cmdlet adds a network interface configuration to the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add a network interface configuration to the VMSS -``` -PS C:\> Add-AzureRmVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "Test" -Primary $True -IPConfiguration $IPCfg -``` - -This command adds a network interface configuration to the VMSS. - -## 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 -``` - -### -DnsSettingsDnsServer -List of dns server IP addresses for dns settings. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DnsServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAcceleratedNetworking -Specifies whether the network interface is accelerated networking-enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableIPForwarding -Specifies whether IP forwarding enabled on this NIC. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfiguration -Specifies the IP configurations of the network interface. - -```yaml -Type: VirtualMachineScaleSetIPConfiguration[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Id of the network security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Primary -Indicates whether network interfaces created from the network interface configuration will be the primary network information center (NIC) of the virtual machine. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSecret.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSecret.md deleted file mode 100644 index 11e1622ede..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSecret.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 656BE930-E778-40B0-8A75-BFE52DE386CE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsssecret -schema: 2.0.0 ---- - -# Add-AzureRmVmssSecret - -## SYNOPSIS -Adds a secret to a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssSecret [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-SourceVaultId] <String>] - [[-VaultCertificate] <VaultCertificate[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssSecret** cmdlet adds a secret to the Virtual Machine Scale Set (VMSS). -The secret must be stored in an Azure Key Vault. -For more information relating to Key Vault, see [What is Azure Key Vault?](https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/) (https://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/). -For more information about the cmdlets, see [Azure Key Vault Cmdlets](/powershell/module/azurerm.keyvault/) in the Microsoft Developer Network library or the [Set-AzureKeyVaultSecret](/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret) cmdlet. - -## EXAMPLES - -### Example 1: Add a secret to the VMSS -``` -PS C:\> $Vault = Get-AzureRmKeyVault -VaultName "ContosoVault" -PS C:\> $CertConfig = New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates" -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfig -``` - -This example adds a secret to the VMSS. -The first command uses the Get-AzureRmKeyVault cmdlet to get a vault secret from the vault named ContosoVault and stores the result in the variable named $Vault. -The second command uses the **New-AzureRmVmssVaultCertificateConfig** cmdlet to create a Key Vault certificate configuration using the specified certificate URL from the certificate store named Certificates and stores the results in the variable named $CertConfig. -The third command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The fourth command adds a secret to the VMSS using the vault secret using the key resource ID and the vault certificate stored in the $Vault and $CertConfig variables. - -## 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 -``` - -### -SourceVaultId -Specifies the resource ID of the Key Vault that contains the certificates that you can add to the virtual machine. -This value also acts as the key for adding multiple certificates. -This means that you can use the same value for the *SourceVaultId* parameter when you add multiple certificates from the same Key Vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultCertificate -Specifies the Vault **Certificate** object that contains the certificate URL and certificate name. -You can use the [New-AzureRmVmssVaultCertificateConfig](./New-AzureRmVmssVaultCertificateConfig.md) cmdlet to create this object. - -```yaml -Type: VaultCertificate[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create this object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### None -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssVaultCertificateConfig](./New-AzureRmVmssVaultCertificateConfig.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSshPublicKey.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSshPublicKey.md deleted file mode 100644 index f8d481aaf7..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssSshPublicKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9C216103-EB77-468E-8684-F5E5400B73A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsssshpublickey -schema: 2.0.0 ---- - -# Add-AzureRmVmssSshPublicKey - -## SYNOPSIS -Adds SSH public keys to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssSshPublicKey [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Path] <String>] - [[-KeyData] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssSshPublicKey** cmdlet adds the public keys that you can use to connect to the Virtual Machine Scale Set (VMSS) virtual machines over Secure Shell (SSH). - -## EXAMPLES - -### Example 1: Add an SSH public key to the VMSS -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssSshPublicKey -VirtualMachineScaleSet $VMSS -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys" -``` - -This example adds an SSH public key to the VMSS. - -The first command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The second command adds an SSH key with the specified key data and stores the key at the specified path on the virtual machine. - -## 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 -``` - -### -KeyData -Specifies a SSH RSA public key data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path of a file, on the virtual machine, where this cmdlet stores the SSH public key. -If the file already exists, this cmdlet appends the key to the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the [New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssWinRMListener.md b/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssWinRMListener.md deleted file mode 100644 index 530f2250d5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Add-AzureRmVmssWinRMListener.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 987BD670-20F3-4105-A5BE-03E712AB2B56 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/add-azurermvmsswinrmlistener -schema: 2.0.0 ---- - -# Add-AzureRmVmssWinRMListener - -## SYNOPSIS -Adds a WinRM listener to the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVmssWinRMListener [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Protocol] <ProtocolTypes>] - [[-CertificateUrl] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVmssWinRMListener** cmdlet adds a Windows Remote Management (WinRM) listener on the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Add a WinRM listener to the VMSS -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -PS C:\> Add-AzureRmVmssWinRMListener -VirtualMachineScaleSet $VMSS -Protocol Https -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -``` - -This example adds a WinRM listener to the VMSS. - -The first command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The second command adds an HTTP protocol WinRM listener with the certificate at the specified URL to the VMSS. - -## PARAMETERS - -### -CertificateUrl -Specifies a link, as a URL, of the certificate with which new virtual machines are provisioned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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 -``` - -### -Protocol -Specifies the protocol of the WinRM listener. -The acceptable values for this parameter are: - -- Http -- Https - -```yaml -Type: ProtocolTypes -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/AzureRM.Compute.md b/azurermps-2.5.0/AzureRm.Compute/AzureRM.Compute.md deleted file mode 100644 index 20edecb85e..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/AzureRM.Compute.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -Module Name: AzureRM.Compute -Module Guid: 0a83c907-1ffb-4d87-a492-c65ac7d7ed37 -Download Help Link: -Help Version: 3.5.0.0 -Locale: en-US ---- - -# AzureRM.Compute Module -## Description -This topic displays the help topics for the Azure Compute Cmdlets. - -## AzureRM.Compute Cmdlets -### [Add-AzureRmContainerServiceAgentPoolProfile](Add-AzureRmContainerServiceAgentPoolProfile.md) -Adds a container service agent pool profile. - -### [Add-AzureRmImageDataDisk](Add-AzureRmImageDataDisk.md) -Adds a data disk to an image object. - -### [Add-AzureRmVhd](Add-AzureRmVhd.md) -Uploads a virtual hard disk from an on-premises virtual machine to a blob in a cloud storage account in Azure. - -### [Add-AzureRmVMAdditionalUnattendContent](Add-AzureRmVMAdditionalUnattendContent.md) -Adds information to the unattended Windows Setup answer file. - -### [Add-AzureRmVMDataDisk](Add-AzureRmVMDataDisk.md) -Adds a data disk to a virtual machine. - -### [Add-AzureRmVMNetworkInterface](Add-AzureRmVMNetworkInterface.md) -Adds a network interface to a virtual machine. - -### [Add-AzureRmVMSecret](Add-AzureRmVMSecret.md) -Adds a secret to a virtual machine. - -### [Add-AzureRmVmssAdditionalUnattendContent](Add-AzureRmVmssAdditionalUnattendContent.md) -Adds information to the unattended Windows Setup answer file. - -### [Add-AzureRmVmssDataDisk](Add-AzureRmVmssDataDisk.md) -Adds a data disk to the VMSS. - -### [Add-AzureRmVmssDiagnosticsExtension](Add-AzureRmVmssDiagnosticsExtension.md) -Adds a diagnostics extension to the VMSS. - -### [Add-AzureRmVmssExtension](Add-AzureRmVmssExtension.md) -Adds an extension to the VMSS. - -### [Add-AzureRmVMSshPublicKey](Add-AzureRmVMSshPublicKey.md) -Adds the public keys for SSH for a virtual machine. - -### [Add-AzureRmVmssNetworkInterfaceConfiguration](Add-AzureRmVmssNetworkInterfaceConfiguration.md) -Adds a network interface configuration to the VMSS. - -### [Add-AzureRmVmssSecret](Add-AzureRmVmssSecret.md) -Adds a secret to a VMSS. - -### [Add-AzureRmVmssSshPublicKey](Add-AzureRmVmssSshPublicKey.md) -Adds SSH public keys to the VMSS. - -### [Add-AzureRmVmssWinRMListener](Add-AzureRmVmssWinRMListener.md) -Adds a WinRM listener to the VMSS. - -### [ConvertTo-AzureRmVMManagedDisk](ConvertTo-AzureRmVMManagedDisk.md) -Converts a virtual machine with blob-based disks to a virtual machine with managed disks. - -### [Disable-AzureRmVMDiskEncryption](Disable-AzureRmVMDiskEncryption.md) -Disables encryption on an IaaS virtual machine. - -### [Disable-AzureRmVmssDiskEncryption](Disable-AzureRmVmssDiskEncryption.md) -Disables disk encryption on a VM scale set. - -### [Export-AzureRmLogAnalyticRequestRateByInterval](Export-AzureRmLogAnalyticRequestRateByInterval.md) -Export logs that show Api requests made by this subscription in the given time window to show throttling activities. - -### [Export-AzureRmLogAnalyticThrottledRequests](Export-AzureRmLogAnalyticThrottledRequests.md) -Export logs that show total throttled Api requests for this subscription in the given time window. - -### [Get-AzureRmAvailabilitySet](Get-AzureRmAvailabilitySet.md) -Gets Azure availability sets in a resource group. - -### [Get-AzureRmComputeResourceSku](Get-AzureRmComputeResourceSku.md) -List all compute resource Skus - -### [Get-AzureRmContainerService](Get-AzureRmContainerService.md) -Gets a container service. - -### [Get-AzureRmDisk](Get-AzureRmDisk.md) -Gets the properties of a Managed disk. - -### [Get-AzureRmImage](Get-AzureRmImage.md) -Gets the properties of an image. - -### [Get-AzureRmRemoteDesktopFile](Get-AzureRmRemoteDesktopFile.md) -Gets an .rdp file. - -### [Get-AzureRmSnapshot](Get-AzureRmSnapshot.md) -Gets the properties of a snapshot - -### [Get-AzureRmVM](Get-AzureRmVM.md) -Gets the properties of a virtual machine. - -### [Get-AzureRmVMAccessExtension](Get-AzureRmVMAccessExtension.md) -Gets information about the VMAccess extension. - -### [Get-AzureRmVMADDomainExtension](Get-AzureRmVMADDomainExtension.md) -Gets information about an AD domain extension. - -### [Get-AzureRmVMAEMExtension](Get-AzureRmVMAEMExtension.md) -Gets information about the AEM extension. - -### [Get-AzureRmVMBootDiagnosticsData](Get-AzureRmVMBootDiagnosticsData.md) -Gets boot diagnostics data for a virtual machine. - -### [Get-AzureRmVMChefExtension](Get-AzureRmVMChefExtension.md) -Gets information about a Chef extension. - -### [Get-AzureRmVMCustomScriptExtension](Get-AzureRmVMCustomScriptExtension.md) -Gets information about a custom script extension. - -### [Get-AzureRmVMDiagnosticsExtension](Get-AzureRmVMDiagnosticsExtension.md) -Gets the settings of the Diagnostics extension on a virtual machine. - -### [Get-AzureRmVMDiskEncryptionStatus](Get-AzureRmVMDiskEncryptionStatus.md) -Gets the encryption status of the virtual machine. - -### [Get-AzureRmVMDscExtension](Get-AzureRmVMDscExtension.md) -Gets the settings of the DSC extension on a particular virtual machine. - -### [Get-AzureRmVMDscExtensionStatus](Get-AzureRmVMDscExtensionStatus.md) -Gets the status of the DSC extension handler for a virtual machine. - -### [Get-AzureRmVMExtension](Get-AzureRmVMExtension.md) -Gets properties of Virtual Machine Extensions installed on a virtual machine. - -### [Get-AzureRmVMExtensionImage](Get-AzureRmVMExtensionImage.md) -Gets all versions for an Azure extension. - -### [Get-AzureRmVMExtensionImageType](Get-AzureRmVMExtensionImageType.md) -Gets the type of an Azure extension. - -### [Get-AzureRmVMImage](Get-AzureRmVMImage.md) -Gets all the versions of a VMImage. - -### [Get-AzureRmVMImageOffer](Get-AzureRmVMImageOffer.md) -Gets VMImage offer types. - -### [Get-AzureRmVMImagePublisher](Get-AzureRmVMImagePublisher.md) -Gets the VMImage publishers. - -### [Get-AzureRmVMImageSku](Get-AzureRmVMImageSku.md) -Gets VMImage SKUs. - -### [Get-AzureRmVMRunCommandDocument](Get-AzureRmVMRunCommandDocument.md) -Get run command document. - -### [Get-AzureRmVMSize](Get-AzureRmVMSize.md) -Gets available virtual machine sizes. - -### [Get-AzureRmVMSqlServerExtension](Get-AzureRmVMSqlServerExtension.md) -Gets the settings for a SQL Server extension on a virtual machine. - -### [Get-AzureRmVmss](Get-AzureRmVmss.md) -Gets the properties of a VMSS. - -### [Get-AzureRmVmssDiskEncryption](Get-AzureRmVmssDiskEncryption.md) -Shows the disk encryption status of a VM scale set. - -### [Get-AzureRmVmssRollingUpgrade](Get-AzureRmVmssRollingUpgrade.md) -Shows the status of the latest virtual machine scale set rolling upgrade. - -### [Get-AzureRmVmssSku](Get-AzureRmVmssSku.md) -Gets the available SKUs for the VMSS. - -### [Get-AzureRmVmssVM](Get-AzureRmVmssVM.md) -Gets the properties of a VMSS virtual machine. - -### [Get-AzureRmVmssVMDiskEncryption](Get-AzureRmVmssVMDiskEncryption.md) -Shows the disk encryption status of VMs in a VM scale set. - -### [Get-AzureRmVMUsage](Get-AzureRmVMUsage.md) -Gets the virtual machine core count usage for a location. - -### [Grant-AzureRmDiskAccess](Grant-AzureRmDiskAccess.md) -Grants an access to a disk. - -### [Grant-AzureRmSnapshotAccess](Grant-AzureRmSnapshotAccess.md) -Grants an access to a snapshot. - -### [Invoke-AzureRmVMRunCommand](Invoke-AzureRmVMRunCommand.md) -Run command on the VM. - -### [New-AzureRmAvailabilitySet](New-AzureRmAvailabilitySet.md) -Creates an Azure availability set. - -### [New-AzureRmContainerService](New-AzureRmContainerService.md) -Creates a container service. - -### [New-AzureRmContainerServiceConfig](New-AzureRmContainerServiceConfig.md) -Creates a local configuration object for a container service. - -### [New-AzureRmDisk](New-AzureRmDisk.md) -Creates a managed disk. - -### [New-AzureRmDiskConfig](New-AzureRmDiskConfig.md) -Creates a configurable disk object. - -### [New-AzureRmDiskUpdateConfig](New-AzureRmDiskUpdateConfig.md) -Creates a configurable disk update object. - -### [New-AzureRmImage](New-AzureRmImage.md) -Creates an image. - -### [New-AzureRmImageConfig](New-AzureRmImageConfig.md) -Creates a configurable image object. - -### [New-AzureRmSnapshot](New-AzureRmSnapshot.md) -Creates a snapshot. - -### [New-AzureRmSnapshotConfig](New-AzureRmSnapshotConfig.md) -Creates a configurable snapshot object. - -### [New-AzureRmSnapshotUpdateConfig](New-AzureRmSnapshotUpdateConfig.md) -Creates a configurable snapshot update object. - -### [New-AzureRmVM](New-AzureRmVM.md) -Creates a virtual machine. - -### [New-AzureRmVMConfig](New-AzureRmVMConfig.md) -Creates a configurable virtual machine object. - -### [New-AzureRmVMSqlServerAutoBackupConfig](New-AzureRmVMSqlServerAutoBackupConfig.md) -Creates a configuration object for SQL Server automatic backup. - -### [New-AzureRmVMSqlServerAutoPatchingConfig](New-AzureRmVMSqlServerAutoPatchingConfig.md) -Creates a configuration object for automatic patching on a virtual machine. - -### [New-AzureRmVMSqlServerKeyVaultCredentialConfig](New-AzureRmVMSqlServerKeyVaultCredentialConfig.md) -Creates a configuration object for SQL server key vault credential on a virtual machine. - -### [New-AzureRmVmss](New-AzureRmVmss.md) -Creates a VMSS. - -### [New-AzureRmVmssConfig](New-AzureRmVmssConfig.md) -Creates a VMSS configuration object. - -### [New-AzureRmVmssIpConfig](New-AzureRmVmssIpConfig.md) -Creates an IP configuration for a network interface of a VMSS. - -### [New-AzureRmVmssVaultCertificateConfig](New-AzureRmVmssVaultCertificateConfig.md) -Creates a Key Vault certificate configuration. - -### [Publish-AzureRmVMDscConfiguration](Publish-AzureRmVMDscConfiguration.md) -Uploads a DSC script to Azure blob storage. - -### [Remove-AzureRmAvailabilitySet](Remove-AzureRmAvailabilitySet.md) -Removes an availability set from Azure. - -### [Remove-AzureRmContainerService](Remove-AzureRmContainerService.md) -Removes a container service. - -### [Remove-AzureRmContainerServiceAgentPoolProfile](Remove-AzureRmContainerServiceAgentPoolProfile.md) -Removes an agent pool profile from a container service. - -### [Remove-AzureRmDisk](Remove-AzureRmDisk.md) -Removes a disk. - -### [Remove-AzureRmImage](Remove-AzureRmImage.md) -Removes an image. - -### [Remove-AzureRmImageDataDisk](Remove-AzureRmImageDataDisk.md) -Removes a data disk from an image object. - -### [Remove-AzureRmSnapshot](Remove-AzureRmSnapshot.md) -Removes a snapshot. - -### [Remove-AzureRmVM](Remove-AzureRmVM.md) -Removes a virtual machine from Azure. - -### [Remove-AzureRmVMAccessExtension](Remove-AzureRmVMAccessExtension.md) -Removes the VMAccess extension from a virtual machine. - -### [Remove-AzureRmVMAEMExtension](Remove-AzureRmVMAEMExtension.md) -Removes the AEM extension from a virtual machine. - -### [Remove-AzureRmVMBackup](Remove-AzureRmVMBackup.md) -Removes the backup from a virtual machine. - -### [Remove-AzureRmVMChefExtension](Remove-AzureRmVMChefExtension.md) -Removes the Chef extension from a virtual machine. - -### [Remove-AzureRmVMCustomScriptExtension](Remove-AzureRmVMCustomScriptExtension.md) -Removes a custom script extension from a virtual machine. - -### [Remove-AzureRmVMDataDisk](Remove-AzureRmVMDataDisk.md) -Removes a data disk from a virtual machine. - -### [Remove-AzureRmVMDiagnosticsExtension](Remove-AzureRmVMDiagnosticsExtension.md) -Removes the Diagnostics extension from a virtual machine. - -### [Remove-AzureRmVMDiskEncryptionExtension](Remove-AzureRmVMDiskEncryptionExtension.md) -Removes the disk encryption extension from a virtual machine. - -### [Remove-AzureRmVMDscExtension](Remove-AzureRmVMDscExtension.md) -Removes a DSC extension handler from a virtual machine in a resource group. - -### [Remove-AzureRmVMExtension](Remove-AzureRmVMExtension.md) -Removes an extension from a virtual machine. - -### [Remove-AzureRmVMNetworkInterface](Remove-AzureRmVMNetworkInterface.md) -Removes a network interface from a virtual machine. - -### [Remove-AzureRmVMSecret](Remove-AzureRmVMSecret.md) -Removes (a) secret(s) from a virtual machine object - -### [Remove-AzureRmVMSqlServerExtension](Remove-AzureRmVMSqlServerExtension.md) -Removes a SQL Server extension from a virtual machine. - -### [Remove-AzureRmVmss](Remove-AzureRmVmss.md) -Removes the VMSS or a virtual machine that is within the VMSS. - -### [Remove-AzureRmVmssDataDisk](Remove-AzureRmVmssDataDisk.md) -Removes a data disk from the VMSS. - -### [Remove-AzureRmVmssDiagnosticsExtension](Remove-AzureRmVmssDiagnosticsExtension.md) -Removes a diagnostics extension from the VMSS. - -### [Remove-AzureRmVmssExtension](Remove-AzureRmVmssExtension.md) -Removes an extension from the VMSS. - -### [Remove-AzureRmVmssNetworkInterfaceConfiguration](Remove-AzureRmVmssNetworkInterfaceConfiguration.md) -Removes a network interface configuration from a VMSS. - -### [Restart-AzureRmVM](Restart-AzureRmVM.md) -Restarts an Azure virtual machine. - -### [Restart-AzureRmVmss](Restart-AzureRmVmss.md) -Restarts the VMSS or a virtual machine within the VMSS. - -### [Revoke-AzureRmDiskAccess](Revoke-AzureRmDiskAccess.md) -Revokes an access to a disk. - -### [Revoke-AzureRmSnapshotAccess](Revoke-AzureRmSnapshotAccess.md) -Revokes an access to a snapshot. - -### [Save-AzureRmVhd](Save-AzureRmVhd.md) -Saves downloaded .vhd images locally. - -### [Save-AzureRmVMImage](Save-AzureRmVMImage.md) -Saves a virtual machine as a VMImage. - -### [Set-AzureRmDiskDiskEncryptionKey](Set-AzureRmDiskDiskEncryptionKey.md) -Sets the disk encryption key properties on a disk object. - -### [Set-AzureRmDiskImageReference](Set-AzureRmDiskImageReference.md) -Sets the image reference properties on a disk object. - -### [Set-AzureRmDiskKeyEncryptionKey](Set-AzureRmDiskKeyEncryptionKey.md) -Sets the key encryption key properties on a disk object. - -### [Set-AzureRmDiskUpdateDiskEncryptionKey](Set-AzureRmDiskUpdateDiskEncryptionKey.md) -Sets the disk encryption key properties on a disk update object. - -### [Set-AzureRmDiskUpdateKeyEncryptionKey](Set-AzureRmDiskUpdateKeyEncryptionKey.md) -Sets the key encryption key properties on a disk update object. - -### [Set-AzureRmImageOsDisk](Set-AzureRmImageOsDisk.md) -Sets the operating system disk properties on an image object. - -### [Set-AzureRmSnapshotDiskEncryptionKey](Set-AzureRmSnapshotDiskEncryptionKey.md) -Sets the disk encryption key properties on a snapshot object. - -### [Set-AzureRmSnapshotImageReference](Set-AzureRmSnapshotImageReference.md) -Sets the image reference properties on a snapshot object. - -### [Set-AzureRmSnapshotKeyEncryptionKey](Set-AzureRmSnapshotKeyEncryptionKey.md) -Sets the key encryption key properties on a snapshot object. - -### [Set-AzureRmSnapshotUpdateDiskEncryptionKey](Set-AzureRmSnapshotUpdateDiskEncryptionKey.md) -Sets the disk encryption key properties on a snapshot update object. - -### [Set-AzureRmSnapshotUpdateKeyEncryptionKey](Set-AzureRmSnapshotUpdateKeyEncryptionKey.md) -Sets the key encryption key properties on a snapshot update object. - -### [Set-AzureRmVM](Set-AzureRmVM.md) -Marks a virtual machine as generalized. - -### [Set-AzureRmVMAccessExtension](Set-AzureRmVMAccessExtension.md) -Adds the VMAccess extension to a virtual machine. - -### [Set-AzureRmVMADDomainExtension](Set-AzureRmVMADDomainExtension.md) -Adds an AD domain extension to a virtual machine. - -### [Set-AzureRmVMAEMExtension](Set-AzureRmVMAEMExtension.md) -Enables support for monitoring for SAP systems. - -### [Set-AzureRmVMBackupExtension](Set-AzureRmVMBackupExtension.md) -Sets the backup extension properties on a virtual machine. - -### [Set-AzureRmVMBginfoExtension](Set-AzureRmVMBginfoExtension.md) -Adds the BGInfo extension to a virtual machine. - -### [Set-AzureRmVMBootDiagnostics](Set-AzureRmVMBootDiagnostics.md) -Modifies boot diagnostics properties of a virtual machine. - -### [Set-AzureRmVMChefExtension](Set-AzureRmVMChefExtension.md) -Adds a Chef extension to a virtual machine. - -### [Set-AzureRmVMCustomScriptExtension](Set-AzureRmVMCustomScriptExtension.md) -Adds a custom script extension to a virtual machine. - -### [Set-AzureRmVMDataDisk](Set-AzureRmVMDataDisk.md) -Modifies properties of a virtual machine data disk. - -### [Set-AzureRmVMDiagnosticsExtension](Set-AzureRmVMDiagnosticsExtension.md) -Configures the Azure diagnostics extension on a virtual machine. - -### [Set-AzureRmVMDiskEncryptionExtension](Set-AzureRmVMDiskEncryptionExtension.md) -Enables encryption on a running IaaS virtual machine in Azure. - -### [Set-AzureRmVMDscExtension](Set-AzureRmVMDscExtension.md) -Configures the DSC extension on a virtual machine. - -### [Set-AzureRmVMExtension](Set-AzureRmVMExtension.md) -Updates extension properties or adds an extension to a virtual machine. - -### [Set-AzureRmVMOperatingSystem](Set-AzureRmVMOperatingSystem.md) -Sets operating system properties for a virtual machine. - -### [Set-AzureRmVMOSDisk](Set-AzureRmVMOSDisk.md) -Sets the operating system disk properties on a virtual machine. - -### [Set-AzureRmVMPlan](Set-AzureRmVMPlan.md) -Sets the Marketplace plan information on a virtual machine. - -### [Set-AzureRmVMSourceImage](Set-AzureRmVMSourceImage.md) -Specifies the image for a virtual machine. - -### [Set-AzureRmVMSqlServerExtension](Set-AzureRmVMSqlServerExtension.md) -Sets the Azure SQL Server extension on a virtual machine. - -### [Set-AzureRmVmss](Set-AzureRmVmss.md) -Sets specific actions on a specified VMSS. - -### [Set-AzureRmVmssBootDiagnostic](Set-AzureRmVmssBootDiagnostic.md) -Sets the virtual machine scale set boot diagnostics profile. - -### [Set-AzureRmVmssDiskEncryptionExtension](Set-AzureRmVmssDiskEncryptionExtension.md) -Enables disk encryption on a VM scale set. - -### [Set-AzureRmVmssOsProfile](Set-AzureRmVmssOsProfile.md) -Sets the VMSS operating system profile properties. - -### [Set-AzureRmVmssRollingUpgradePolicy](Set-AzureRmVmssRollingUpgradePolicy.md) -Sets the VMSS rolling upgrade policy properties. - -### [Set-AzureRmVmssStorageProfile](Set-AzureRmVmssStorageProfile.md) -Sets the storage profile properties for the VMSS. - -### [Set-AzureRmVmssVM](Set-AzureRmVmssVM.md) -Modifies the state of a VMSS instance. - -### [Start-AzureRmVM](Start-AzureRmVM.md) -Starts an Azure virtual machine. - -### [Start-AzureRmVmss](Start-AzureRmVmss.md) -Starts the VMSS or a set of virtual machines within the VMSS. - -### [Start-AzureRmVmssRollingOSUpgrade](Start-AzureRmVmssRollingOSUpgrade.md) -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. - -### [Stop-AzureRmVM](Stop-AzureRmVM.md) -Stops an Azure virtual machine. - -### [Stop-AzureRmVmss](Stop-AzureRmVmss.md) -Stops the VMSS or a set of virtual machines within the VMSS. - -### [Stop-AzureRmVmssRollingUpgrade](Stop-AzureRmVmssRollingUpgrade.md) -Cancels the current virtual machine scale set rolling upgrade. - -### [Test-AzureRmVMAEMExtension](Test-AzureRmVMAEMExtension.md) -Checks the configuration of the AEM extension. - -### [Update-AzureRmAvailabilitySet](Update-AzureRmAvailabilitySet.md) -Updates an availability set. - -### [Update-AzureRmContainerService](Update-AzureRmContainerService.md) -Updates the state of a container service. - -### [Update-AzureRmDisk](Update-AzureRmDisk.md) -Updates a disk. - -### [Update-AzureRmImage](Update-AzureRmImage.md) -Updates an image. - -### [Update-AzureRmSnapshot](Update-AzureRmSnapshot.md) -Updates a snapshot. - -### [Update-AzureRmVM](Update-AzureRmVM.md) -Updates the state of an Azure virtual machine. - -### [Update-AzureRmVmss](Update-AzureRmVmss.md) -Updates the state of a VMSS. - -### [Update-AzureRmVmssInstance](Update-AzureRmVmssInstance.md) -Starts a manual upgrade of the VMSS instance. - diff --git a/azurermps-2.5.0/AzureRm.Compute/ConvertTo-AzureRmVMManagedDisk.md b/azurermps-2.5.0/AzureRm.Compute/ConvertTo-AzureRmVMManagedDisk.md deleted file mode 100644 index 6c157565ab..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/ConvertTo-AzureRmVMManagedDisk.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/convertto-azurermvmmanageddisk -schema: 2.0.0 ---- - -# ConvertTo-AzureRmVMManagedDisk - -## SYNOPSIS -Converts a virtual machine with blob-based disks to a virtual machine with managed disks. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -ConvertTo-AzureRmVMManagedDisk [-ResourceGroupName] <String> [-VMName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **ConvertTo-AzureRmVMManagedDisk** cmdlet converts a virtual machine with blob-based disks to a virtual machine with managed disks. -The virtual machine must be stop-deallocated before invoking this operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> ConvertTo-AzureRmVMManagedDisk -ResourceGroupName 'ResourceGroup01' -VMName 'VM01' -``` - -This command converts the blob-based disks of the virtual machine named 'VM01' in the resource group 'ResourceGroup01' to managed disks. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVMDiskEncryption.md b/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVMDiskEncryption.md deleted file mode 100644 index 78d7f62cff..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVMDiskEncryption.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 979E956B-4C74-426E-A617-E50C4EBC8A20 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/disable-azurermvmdiskencryption -schema: 2.0.0 ---- - -# Disable-AzureRmVMDiskEncryption - -## SYNOPSIS -Disables encryption on an IaaS virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmVMDiskEncryption [-ResourceGroupName] <String> [-VMName] <String> [[-VolumeType] <String>] - [[-Name] <String>] [[-TypeHandlerVersion] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] - [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmVMDiskEncryption** cmdlet disables encryption on an infrastructure as a service (IaaS) virtual machine. -This cmdlet is only supported on Windows virtual machines and not Linux virtual machines. -This cmdlet installs an extension on the virtual machine to disable encryption. -If the *Name* parameter is not specified, an extension with the default name "AzureDiskEncryption for Windows VMs" is created. -Caution: This cmdlet reboots the virtual machine. - -## EXAMPLES - -### Example 1: Disable encryption for all volumes on a Windows virtual machine -``` -PS C:\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group001" -VMName "VM002" -``` - -This command disables encryption for volumes of type all for the virtual machine named VM002 that belongs to the resource group named Group001. -Since the *VolumeType* parameter is not specified, the cmdlet sets the value to All. - -### Example 2: Disable encryption for data volumes on a Windows virtual machine -``` -PS C:\> $ResourceGroup = "Group002"; -PS C:\> $VMName = "VM004"; -PS C:\> Disable-AzureRMVMDiskEncryption -ResourceGroupName "Group002" -VMName "VM004" -VolumeType "Data" -``` - -This command disables encryption for volumes of type data for the virtual machine named VM004 that belongs to the resource group named Group002. - -## 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 -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifes the name of the Azure Resource Manager (ARM) resource that represents the extension. -If this parameter is not specified, this cmdlet defaults to "AzureDiskEncryption for Windows VMs". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the encryption extension. -If you do not specify a value for this parameter, the latest version of the extension is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that this cmdlet disables encryption on. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Specifies the type of virtual machine volumes to perform the encryption operation. -For Windows virtual machines, valid values are: - -- All -- OS -- Data. -If you do not specify a value for this parameter, the default value is All. -Disable encryption is not currently supported for Linux. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: 2 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVmssDiskEncryption.md b/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVmssDiskEncryption.md deleted file mode 100644 index 7fbb1e2f42..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Disable-AzureRmVmssDiskEncryption.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/disable-azurermvmssdiskencryption -schema: 2.0.0 ---- - -# Disable-AzureRmVmssDiskEncryption - -## SYNOPSIS -Disables disk encryption on a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Disable-AzureRmVmssDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-ExtensionName] <String>] [-VolumeType <String>] [-ForceUpdate] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Disables disk encryption on a VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Disable-AzureRmVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -Disables disk encryption on the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -To force the removal of the extension from the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdate -Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Type of the volume (OS or Data) to perform encryption operation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md b/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md deleted file mode 100644 index 330924f5c5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticRequestRateByInterval.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/export-azurermloganalyticrequestratebyinterval -schema: 2.0.0 ---- - -# Export-AzureRmLogAnalyticRequestRateByInterval - -## SYNOPSIS -Export logs that show Api requests made by this subscription in the given time window to show throttling activities. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmLogAnalyticRequestRateByInterval [-Location] <String> [-FromTime] <DateTime> [-ToTime] <DateTime> - [-BlobContainerSasUri] <String> [-IntervalLength] <IntervalInMins> - [-GroupByOperationName] [-GroupByThrottlePolicy] [-GroupByResourceName] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This exports aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled displayed in time intervals. -The logs can be further grouped by three parameters: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName. -Note that this cmdlet collects only CRP logs. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Export-AzureRmLogAnalyticRequestRateByInterval -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -IntervalLength ThirtyMins -GroupByOperationName -``` - -This command stores the aggregated numbers of Microsoft.Compute API calls separated by Success, Failure, or Throttled between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobContainerSasUri -SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromTime -From time of the query - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByOperationName -Group query result by Operation Name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByResourceName -Group query result by Resource Name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByThrottlePolicy -Group query result by Throttle Policy applied. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalLength -Interval value in minutes used to create LogAnalytics call rate logs. - -```yaml -Type: IntervalInMins -Parameter Sets: (All) -Aliases: -Accepted values: ThreeMins, FiveMins, ThirtyMins, SixtyMins - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location upon which log analytic is queried. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ToTime -To time of the query - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticThrottledRequests.md b/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticThrottledRequests.md deleted file mode 100644 index e5ffad0884..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Export-AzureRmLogAnalyticThrottledRequests.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/export-azurermloganalyticthrottledrequests -schema: 2.0.0 ---- - -# Export-AzureRmLogAnalyticThrottledRequests - -## SYNOPSIS -Export logs that show total throttled Api requests for this subscription in the given time window. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmLogAnalyticThrottledRequests [-Location] <String> [-FromTime] <DateTime> [-ToTime] <DateTime> - [-BlobContainerSasUri] <String> - [-GroupByOperationName] [-GroupByThrottlePolicy] [-GroupByResourceName] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -This exports the total number of throttled Microsoft.Compute API calls. -The logs can be further aggregated by three options: GroupByOperationName, GroupByThrottlePolicy, or GroupByResourceName. -Note that this cmdlet collects only CRP logs. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Export-AzureRmLogAnalyticThrottledRequests -Location 'West Central US' -FromTime '2018-02-20T17:54:14.8806951-08:00' -ToTime '2018-02-22T17:54:17.5832413-08:00' -BlobContainerSasUri 'https://wkuotest1.blob.core.windows.net/mylogs?someSasUri' -GroupByOperationName -``` - -This command stores the total throttled Microsoft.Compute API calls between 2018-02-20T17:54:14 and 2018-02-22T17:54:17 in the given SAS URI, aggregated by operation name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlobContainerSasUri -SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromTime -From time of the query - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByOperationName -Group query result by Operation Name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByResourceName -Group query result by Resource Name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupByThrottlePolicy -Group query result by Throttle Policy applied. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location upon which log analytic is queried. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ToTime -To time of the query - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSLogAnalyticsOperationResult - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMDiagnosticsExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMDiagnosticsExtension.md deleted file mode 100644 index cb1f46af8c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMDiagnosticsExtension.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5BEA683-44AE-4D71-827D-02A03F0BEAE9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdiagnosticsextension -schema: 2.0.0 ---- - -# Get-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Gets the settings of the Diagnostics extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDiagnosticsExtension** cmdlet gets the settings of the Azure Diagnostics extension on a virtual machine. - -## EXAMPLES - -### Example 1: Get the diagnostics extension applied to a virtual machine -``` -PS C:\> Get-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" -``` - -This command gets the diagnostics extension applied to the virtual machine named ContosoVM22. - -## 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 -Specifies the name of the Diagnostics extension for which this cmdlet gets settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet uses the Status value. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet gets the Diagnostics extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMSqlServerExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMSqlServerExtension.md deleted file mode 100644 index 2110cf819b..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CAA3E6A9-7E1A-4D57-A269-0B2D3D9C3BEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsqlserverextension -schema: 2.0.0 ---- - -# Get-AzureRmVMSqlServerExtension - -## SYNOPSIS -Gets the settings for a SQL Server extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMSqlServerExtension** cmdlet gets the settings of the SQL Server infrastructure as a service (IaaS) Agent on a virtual machine. - -## EXAMPLES - -### Example 1: Get the settings of a SQL Server extension on a virtual machine -``` -PS C:\> Get-AzureRmVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the settings of the SQL Server extension on a virtual machine named ContosoVM07. - -### Example 2: Get the settings by using the pipeline -``` -PS C:\> Get-AzureRmVM -ServiceName "Service08" -Name "ContosoVM22" | Get-AzureRmVMSqlServerExtension -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the virtual machine named ContosoVM22 on the service Service08 by using the Get-AzureRmVM cmdlet. -The command passes the results to the current cmdlet by using the pipeline operator. - -The current command gets the settings of the SQL Server IaaS Agent on that virtual machine. - -### Example 3: Get the settings of specific SQL Server version -``` -PS C:\> Get-AzureRmVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -Version "1.0" -ExtensionName : SqlIaaSAgent -Publisher : Microsoft.SqlServer.Management -Version : 1.0 -State : Enable -RoleName : VMName -AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings -AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings -``` - -This command gets the settings of version 1.0 of the SQL Server extension on a virtual machine named ContosoVM07. - -## 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 -Specifies the name of the SQL Server the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.VirtualMachineSqlServerExtensionContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Remove-AzureRmVMSqlServerExtension](./Remove-AzureRMVMSqlServerExtension.md) - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmAvailabilitySet.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmAvailabilitySet.md deleted file mode 100644 index 6fc342c7b8..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 45D55DC9-0027-4EB9-B2F7-9ABF6685E6B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermavailabilityset -schema: 2.0.0 ---- - -# Get-AzureRmAvailabilitySet - -## SYNOPSIS -Gets Azure availability sets in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAvailabilitySet [-ResourceGroupName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAvailabilitySet** cmdlet gets Azure availability sets in a resource group. -You can specify the name of a specific availability set to get. - -## EXAMPLES - -### Example 1: Get a specific availability set -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -``` - -This command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -### Example 2: Get all availability sets -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -``` - -This command gets all the availability sets in the resource group named 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 -``` - -### -Name -Specifies the name of an availability set that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS - -[New-AzureRmAvailabilitySet](./New-AzureRmAvailabilitySet.md) - -[Remove-AzureRmAvailabilitySet](./Remove-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmComputeResourceSku.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmComputeResourceSku.md deleted file mode 100644 index 0fe61feec9..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmComputeResourceSku.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermcomputeresourcesku -schema: 2.0.0 ---- - -# Get-AzureRmComputeResourceSku - -## SYNOPSIS -List all compute resource Skus - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmComputeResourceSku [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -List all compute resource Skus - -## EXAMPLES - -### Example 1 -``` -PS C:\> PS C:\> Get-AzureRmComputeResourceSku | where {$_.Locations.Contains("westus")}; -``` - -List all compute resource skus in West US region - -## 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 -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmContainerService.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmContainerService.md deleted file mode 100644 index a99bbd5862..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmContainerService.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: AFF75E0B-CB88-45ED-9067-7F43E2BA485C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermcontainerservice -schema: 2.0.0 ---- - -# Get-AzureRmContainerService - -## SYNOPSIS -Gets a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmContainerService [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmContainerService** cmdlet gets a container service. -You can view the properties of a container service, which include state, number of master and agents, and fully qualified domain name of master and agent. - -## EXAMPLES - -### Example 1: Get a container service -``` -PS C:\> Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command gets a container service named CSResourceGroup17. - -## 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 -Specifies the name of the container service that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmDisk.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmDisk.md deleted file mode 100644 index 86cc0c3eee..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmDisk.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermdisk -schema: 2.0.0 ---- - -# Get-AzureRmDisk - -## SYNOPSIS -Gets the properties of a Managed disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDisk [[-ResourceGroupName] <String>] [[-DiskName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDisk** cmdlet gets the properties of a Managed disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -``` - -This command gets the properties of the disk named 'Disk01' in the resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -``` - -This command gets the properties of all disks in the resource group 'ResourceGroup01'. - -### Example 3 -``` -PS C:\> Get-AzureRmDisk -``` - -This command gets the properties of all disks under the subscription. - -## 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 -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmImage.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmImage.md deleted file mode 100644 index 8780076acc..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmImage.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermimage -schema: 2.0.0 ---- - -# Get-AzureRmImage - -## SYNOPSIS -Gets the properties of an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmImage [[-ResourceGroupName] <String>] [[-ImageName] <String>] [[-Expand] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmImage** cmdlet gets the properties of an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' -``` - -This command gets the properties of the image named 'Image01' in the resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -``` - -This command gets the properties of all images in the resource group 'ResourceGroup01'. - -### Example 3 -``` -PS C:\> Get-AzureRmImage -``` - -This command gets the properties of all images under the subscription. - -## 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 -``` - -### -Expand -Specifies the expand expression query. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmRemoteDesktopFile.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmRemoteDesktopFile.md deleted file mode 100644 index fa0a222743..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmRemoteDesktopFile.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E2A56E55-30A3-4A2F-80AE-9D166840909E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermremotedesktopfile -schema: 2.0.0 ---- - -# Get-AzureRmRemoteDesktopFile - -## SYNOPSIS -Gets an .rdp file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Download -``` -Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [-LocalPath] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Launch -``` -Get-AzureRmRemoteDesktopFile [-ResourceGroupName] <String> [-Name] <String> [[-LocalPath] <String>] [-Launch] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRemoteDesktopFile** cmdlet gets a Remote Desktop Protocol (.rdp) file. - -## EXAMPLES - -### Example 1: Get a Remote Desktop file -``` -PS C:\> Get-AzureRmRemoteDesktopFile -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -LocalPath "D:\RemoteDesktopFile07.rdp" -``` - -This command gets the Remote Desktop file for the virtual machine named VirtualMachine07. -The command stores the result in the file named D:\RemoteDesktopFile07.rdp. - -## 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 -``` - -### -Launch -Indicates that this cmdlet launches Remote Desktop after it gets the .rdp file. - -```yaml -Type: SwitchParameter -Parameter Sets: Launch -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalPath -Specifies the local full path where this cmdlet stores the .rdp file. - -```yaml -Type: String -Parameter Sets: Download -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Launch -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the availability set that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmSnapshot.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmSnapshot.md deleted file mode 100644 index f0950aebdf..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmSnapshot.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermsnapshot -schema: 2.0.0 ---- - -# Get-AzureRmSnapshot - -## SYNOPSIS -Gets the properties of a snapshot - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmSnapshot [[-ResourceGroupName] <String>] [[-SnapshotName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmSnapshot** cmdlet gets the properties of a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmSnapshot -``` - -This command gets the properties of all snapshots of the subscription. - -### Example 2 -``` -PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1" -``` - -This command gets the properties of all snapshots in the resource group named "ResourceGroupName1" - -### Example 3 -``` -PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1" -SnapshotName "SnapshotName1" -``` - -This command gets the properties of the snapshot named "SnapshotName1" in the resource group named "ResourceGroupName1" - -## 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 a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVM.md deleted file mode 100644 index a23b24b24d..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVM.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6250EC11-79CF-428B-A72F-9BD72C1751F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvm -schema: 2.0.0 ---- - -# Get-AzureRmVM - -## SYNOPSIS -Gets the properties of a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAllVirtualMachinesParamSet (Default) -``` -Get-AzureRmVM [-Status] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListVirtualMachineInResourceGroupParamSet -``` -Get-AzureRmVM [-ResourceGroupName] <String> [-Status] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetVirtualMachineInResourceGroupParamSet -``` -Get-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Status] [-DisplayHint <DisplayHintType>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListNextLinkVirtualMachinesParamSet -``` -Get-AzureRmVM [-Status] [-NextLink] <Uri> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVM** cmdlet gets the model view and instance view of an Azure virtual machine. -The model view is the user specified properties of the virtual machine. -The instance view is the instance level status of the virtual machine. -Specify the *Status* parameter to get only the instance view of a virtual machine. - -## EXAMPLES - -### Example 1: Get model and instance view properties -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command gets the model view and instance view properties of the virtual machine named VirtualMachine07. - -### Example 2: Get instance view properties -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Status -``` - -This command gets properties of the virtual machine named VirtualMachine07. -This command specifies the *Status* parameter. -Therefore, the command gets only the instance view properties. - -### Example 3: Get properties for all virtual machines in a resource group -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -``` - -This command gets properties for all the virtual machines in the resource group named ResourceGroup11. - -### Example 4: Get all virtual machines in your subscription -``` -PS C:\> Get-AzureRmVM -``` - -This command gets all the virtual machines in your subscription. - -## 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 -``` - -### -DisplayHint -Determines how the virtual machine object is displayed. - -Valid values are: - --- Compact: displays only top level properties - --- Expand: displays all properties in all levels -```yaml -Type: DisplayHintType -Parameter Sets: GetVirtualMachineInResourceGroupParamSet -Aliases: -Accepted values: Compact, Expand - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to get. - -```yaml -Type: String -Parameter Sets: GetVirtualMachineInResourceGroupParamSet -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextLink -Specifies the next link. - -```yaml -Type: Uri -Parameter Sets: ListNextLinkVirtualMachinesParamSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: ListVirtualMachineInResourceGroupParamSet, GetVirtualMachineInResourceGroupParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMADDomainExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMADDomainExtension.md deleted file mode 100644 index 92445adf7d..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMADDomainExtension.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 49D17667-35C3-4A79-A0C8-C197DAA5CD90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaddomainextension -schema: 2.0.0 ---- - -# Get-AzureRmVMADDomainExtension - -## SYNOPSIS -Gets information about an AD domain extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMADDomainExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMADDomainExtension** cmdlet gets information about the specified Azure Active Directory (AD) domain extension. - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -Specifies the name of the domain extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the domain extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineADDomainExtensionContext - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMADDomainExtension](./Set-AzureRmVMADDomainExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAEMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAEMExtension.md deleted file mode 100644 index 0dd0619f61..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 212281F0-9A3E-4652-919F-400455E3950E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaemextension -schema: 2.0.0 ---- - -# Get-AzureRmVMAEMExtension - -## SYNOPSIS -Gets information about the AEM extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [[-OSType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMAEMExtension** cmdlet gets information about the Azure Enhanced Monitoring (AEM) extension. - -## EXAMPLES - -### Example 1: Get the AEM extension -``` -PS C:\> Get-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command gets information for the AEM extension for the virtual machine named contoso-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 -``` - -### -Name -Specifies the name of a virtual machine. -This cmdlet gets information for the AEM extension on the virtual machine that this cmdlet specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of a virtual machine. -This cmdlet gets information for the AEM extension on that virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the AEM extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets information about AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAccessExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAccessExtension.md deleted file mode 100644 index ee820b677c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 32CF9DA7-5607-4CF9-A2D0-D76A0C005FDA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmaccessextension -schema: 2.0.0 ---- - -# Get-AzureRmVMAccessExtension - -## SYNOPSIS -Gets information about the VMAccess extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMAccessExtension** cmdlet gets information about the Virtual Machine Access (VMAccess) Virtual Machine Extension. - -## EXAMPLES - -### Example 1: Get the VMAccess extension -``` -PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -``` - -This command gets the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. - -### Example 2: Get the instance view of the VMAccess extension -``` -PS C:\> $VMAccessExtension = Get-AzureRmVMAccessExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoTest" -Status -``` - -This command gets the instance view of the VMAccess extension named ContosoTest for the virtual machine named VirtualMachine07. - -## 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 -Specifies the name of the extension that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets information about VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineAccessExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMAccessExtension](./Remove-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMAccessExtension](./Set-AzureRmVMAccessExtension.md) - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMBootDiagnosticsData.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMBootDiagnosticsData.md deleted file mode 100644 index 88cde5bf14..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMBootDiagnosticsData.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 15CAC050-F2E9-4872-88E7-516A6D194FAB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmbootdiagnosticsdata -schema: 2.0.0 ---- - -# Get-AzureRmVMBootDiagnosticsData - -## SYNOPSIS -Gets boot diagnostics data for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### WindowsParamSet (Default) -``` -Get-AzureRmVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Windows] - [-LocalPath] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LinuxParamSet -``` -Get-AzureRmVMBootDiagnosticsData [-ResourceGroupName] <String> [-Name] <String> [-Linux] - [[-LocalPath] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMBootDiagnosticsData** cmdlet gets boot diagnostics data for a virtual machine. - -## EXAMPLES - -### Example 1: Get boot diagnostics data -``` -PS C:\> Get-AzureRmVMBootDiagnosticsData -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" -Windows -LocalPath "C:\Contoso\BootDiagnostics" -``` - -This command gets boot diagnostics data for the virtual machine named ContosoVM07. -This virtual machine runs the Windows operating system. -The command stores the data in specified local path. - -## 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 -``` - -### -Linux -Indicates that the virtual machine runs the Linux operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: LinuxParamSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalPath -Specifies the local path for the boot diagnostics data. - -```yaml -Type: String -Parameter Sets: WindowsParamSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: LinuxParamSet -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine for which this cmdlet gets diagnostics data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the virtual machine runs the Windows operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: WindowsParamSet -Aliases: - -Required: True -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMBootDiagnostics](./Set-AzureRmVMBootDiagnostics.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMChefExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMChefExtension.md deleted file mode 100644 index 64c3176751..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMChefExtension.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: F41953F1-9515-4081-8624-6A1494DA4BB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmchefextension -schema: 2.0.0 ---- - -# Get-AzureRmVMChefExtension - -## SYNOPSIS -Gets information about a Chef extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Get-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-Linux] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Windows -``` -Get-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-Windows] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureVMChefExtension** cmdlet gets information about a Chef extension installed on a virtual machine. - -## EXAMPLES - -### Example 1: Get the details of Chef extension for a Windows virtual machine- -``` -PS C:\> Get-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows -``` - -This command gets the Chef extension from a Windows virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. - -### Example 2: Get the details of Chef extension for a Linux virtual machine -``` -PS C:\> Get-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux -``` - -This command gets the Chef extension from a Linux virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. - -## 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 -``` - -### -Linux -Indicates that this cmdlet works on a Linux virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of the Chef extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet is for a Windows virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMChefExtension](./Set-AzureRmVMChefExtension.md) - -[Remove-AzureRmVMChefExtension](./Remove-AzureRmVMChefExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMCustomScriptExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index d13889a769..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1017A74D-6420-4E51-A4A4-1AD3AD6D8122 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmcustomscriptextension -schema: 2.0.0 ---- - -# Get-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Gets information about a custom script extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMCustomScriptExtension** cmdlet gets information about a custom script Virtual Machine Extension on a virtual machine. - -## EXAMPLES - -### Example 1: Get a custom script extension -``` -PS C:\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" -``` - -This command gets the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. - -### Example 2: Get the instance view of a custom script extension -``` -PS C:\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name "ContosoCustomScript" -Status -``` - -This command gets the instance view of the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07. - -## 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 -Specifies the name of the custom script extension about which this cmdlet gets information. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the custom script extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the custom script extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VirtualMachineCustomScriptExtensionContext - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDiskEncryptionStatus.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDiskEncryptionStatus.md deleted file mode 100644 index 6a2e195474..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDiskEncryptionStatus.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E6F91D2E-6481-44C2-AF21-F62947C3D78C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdiskencryptionstatus -schema: 2.0.0 ---- - -# Get-AzureRmVMDiskEncryptionStatus - -## SYNOPSIS -Gets the encryption status of the virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDiskEncryptionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-ExtensionType <String>] [-ExtensionPublisherName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDiskEncryptionStatus** cmdlet gets the encryption status of the virtual machine. -It displays the encryption status of the operating system and data volumes. -In addition to encryption status, it also displays the encryption secret URL, key encryption key URL, resource IDs of the **KeyVaults** where the encryption key and key encryption key for operating system volume are present. - -## EXAMPLES - -### Example 1: Get the encryption status of a virtual machine -``` -PS C:\> Get-AzureRmVmDiskEncryptionStatus -ResourceGroupName "MyResourceGroup001" -VMName "VM001" -``` - -This command gets the encryption status of the virtual machine named VM001. - -## 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 -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.AzureDiskEncryption.AzureDiskEncryptionExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtension.md deleted file mode 100644 index 45b65d400f..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtension.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5B7A1BE6-F5F5-4968-BE32-7743D0E25FE3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdscextension -schema: 2.0.0 ---- - -# Get-AzureRmVMDscExtension - -## SYNOPSIS -Gets the settings of the DSC extension on a particular virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDscExtension** cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine. - -## EXAMPLES - -### Example 1: Get the settings of a DSC extension -``` -PS C:\> Get-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC" -``` - -This command gets the settings of extension named DSC on the virtual machine named VM07. - -## 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 -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzureRmVMDscExtension**. -Specify this parameter only if you changed the default name in the **Set-AzureRmVMDscExtension** cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets the instance view of the DSC extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the DSC extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.DSC.VirtualMachineDscExtensionContext - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtensionStatus.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtensionStatus.md deleted file mode 100644 index e6b62c8b41..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMDscExtensionStatus.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 695F224D-DA25-49F2-916E-25DA2A48A4A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmdscextensionstatus -schema: 2.0.0 ---- - -# Get-AzureRmVMDscExtensionStatus - -## SYNOPSIS -Gets the status of the DSC extension handler for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMDscExtensionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMDscExtensionStatus** cmdlet gets the status of the Desired State Configuration (DSC) extension handler for a virtual machine in a resource group. -When a configuration is applied this cmdlet produces output consistent with the Start-DscConfiguration cmdlet. - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by **Get-AzureRmVMDscExtensionStatus**. -Specify this parameter only if you changed the default name in the Set cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet gets the DSC extension status. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineInstanceView - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtension.md deleted file mode 100644 index 1b23359b92..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtension.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 842652D4-0F1C-4D0D-AB55-0D43D3C5D82A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextension -schema: 2.0.0 ---- - -# Get-AzureRmVMExtension - -## SYNOPSIS -Gets properties of Virtual Machine Extensions installed on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtension** cmdlet gets properties of Virtual Machine Extensions installed on a virtual machine. -Specify the name of an extension for which to get properties. -To get only the instance view of an extension, specify the Status parameter. - -## EXAMPLES - -### Example 1: Get properties of an extension -``` -PS C:\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -``` - -This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11. - -### Example 2: Get instance view of an extension -``` -PS C:\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status -``` - -This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in 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 -``` - -### -Name -Specifies the name of an extension. -This cmdlet gets properties for the extension that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Indicates that this cmdlet gets only the instance view of an extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet gets properties of an extension from the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImage.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImage.md deleted file mode 100644 index f9d088f61c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImage.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: F46041A3-355F-4449-B582-4D2F7314CA05 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextensionimage -schema: 2.0.0 ---- - -# Get-AzureRmVMExtensionImage - -## SYNOPSIS -Gets all versions for an Azure extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtensionImage -Location <String> -PublisherName <String> -Type <String> - [-FilterExpression <String>] [-Version <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtensionImage** cmdlet gets all versions for an Azure extension. - -## EXAMPLES - -### Example 1: Get the versions of an extension image -``` -PS C:\> Get-AzureRmVMExtensionImage -Location "Central US" -PublisherName "Fabrikam" -Type "FabrikamEndpointProtection" -``` - -This command gets all the versions of the extension image for the specified location, publisher, and type. - -## 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 -``` - -### -FilterExpression -Specifies a filter expression. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of an extension publisher. -To obtain an extension publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the extension. -To obtain an extension type, use the Get-AzureRmVMExtensionImageType cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the extension that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImage - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageDetails - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtensionImageType](./Get-AzureRmVMExtensionImageType.md) - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImageType.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImageType.md deleted file mode 100644 index e188d9059f..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMExtensionImageType.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 45F35BDD-969E-4521-9E8D-3499A15434A6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmextensionimagetype -schema: 2.0.0 ---- - -# Get-AzureRmVMExtensionImageType - -## SYNOPSIS -Gets the type of an Azure extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMExtensionImageType -Location <String> -PublisherName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMExtensionImageType** cmdlet gets the type of an Azure extension. - -## EXAMPLES - -### Example 1: Get an extension image type -``` -PS C:\> Get-AzureRmVMExtensionImageType -Location "Central US" -PublisherName "Fabrikam" -``` - -This command gets the extension image type for the specified publisher and location. - -## 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 location of an extension. -This cmdlet gets the type for an extension at the location that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of an extension. -To obtain an extension publisher, use the Get-AzureRmVMImagePublisher cmdlet. -This cmdlet gets the type for an extension from the publisher that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtensionImageType - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImage.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImage.md deleted file mode 100644 index 4fcd4e3fd8..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImage.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5254218-8B3B-4DE2-9480-D65EE5483018 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimage -schema: 2.0.0 ---- - -# Get-AzureRmVMImage - -## SYNOPSIS -Gets all the versions of a VMImage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListVMImage -``` -Get-AzureRmVMImage -Location <String> -PublisherName <String> -Offer <String> -Skus <String> - [-FilterExpression <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetVMImageDetail -``` -Get-AzureRmVMImage -Location <String> -PublisherName <String> -Offer <String> -Skus <String> -Version <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImage** cmdlet gets all the versions of a VMImage. - -## EXAMPLES - -### Example 1: Get VMImage objects -``` -PS C:\> Get-AzureRmVMImage -Location "Central US" -PublisherName "Canonical" -Offer "UbuntuServer" -Skus "15.04-DAILY" -``` - -This command gets all the versions of VMImage that match the specified values. - -## 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 -``` - -### -FilterExpression -Specifies a filter expression. - -```yaml -Type: String -Parameter Sets: ListVMImage -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of a VMImage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the publisher of a VMImage. -To obtain an image publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skus -Specifies a VMImage SKU. -To obtain an SKU, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the VMImage. - -```yaml -Type: String -Parameter Sets: GetVMImageDetail -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImage - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageDetail - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageOffer.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageOffer.md deleted file mode 100644 index da60fccd81..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageOffer.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2CCAEB4-E43E-4075-9436-77F2C4FE9463 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimageoffer -schema: 2.0.0 ---- - -# Get-AzureRmVMImageOffer - -## SYNOPSIS -Gets VMImage offer types. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImageOffer -Location <String> -PublisherName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImageOffer** cmdlet gets the VMImage offer types. - -## EXAMPLES - -### Example 1: Get offer types for a publisher -``` -PS C:\> Get-AzureRmVMImageOffer -Location "Central US" -PublisherName "Fabrikam" -``` - -This command gets the offer types for the specified publisher in the Central US region. - -## 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 location of the VMImage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageOffer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImagePublisher.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImagePublisher.md deleted file mode 100644 index 319df99382..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImagePublisher.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7311F66C-3370-4436-8030-6D98D42C3112 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimagepublisher -schema: 2.0.0 ---- - -# Get-AzureRmVMImagePublisher - -## SYNOPSIS -Gets the VMImage publishers. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImagePublisher -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImagePublisher** cmdlet gets the VMImage publishers. - -## EXAMPLES - -### Example 1: Get VMImage publishers for a region -``` -PS C:\> Get-AzureRmVMImagePublisher -Location "Central US" -``` - -This command gets the publishers of VMImage instances for the Central US region within your Azure profile. - -## 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 location of the VMImage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImagePublisher - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageSku.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageSku.md deleted file mode 100644 index f62babda35..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMImageSku.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2BBAC5B-A7B9-44DA-BE37-24D89E03BAB3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmimagesku -schema: 2.0.0 ---- - -# Get-AzureRmVMImageSku - -## SYNOPSIS -Gets VMImage SKUs. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMImageSku -Location <String> -PublisherName <String> -Offer <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMImageSku** cmdlet gets VMImage SKUs. - -## EXAMPLES - -### Example 1: Get VMImage SKUs -``` -PS C:\> Get-AzureRmVMImageSku -Location "Central US" -PublisherName "Fabrikam" -Offer "LinuxServer" -``` - -This command gets the SKUs for the specified publisher and offer. - -## 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 location of the VMImage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the publisher of a VMImage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineImageSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Save-AzureRmVMImage](./Save-AzureRmVMImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMRunCommandDocument.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMRunCommandDocument.md deleted file mode 100644 index d6a6b85707..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMRunCommandDocument.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmruncommanddocument -schema: 2.0.0 ---- - -# Get-AzureRmVMRunCommandDocument - -## SYNOPSIS -Get run command document. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMRunCommandDocument [-Location] <String> [[-CommandId] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Get run command document. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus' -CommandId 'RunPowerShellScript' -``` - -Gets a specific run command document for 'RunPowerShellScript' in 'westus'. - - -Get-AzureRmVMRunCommandDocument -Location $loc - -### Example 2 -``` -PS C:\> Get-AzureRmVMRunCommandDocument -Location 'westus' -``` - -Lists all available run commands in 'westus'. - -## PARAMETERS - -### -CommandId -The command id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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 -The location upon which run commands is queried. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandDocument - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMSize.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMSize.md deleted file mode 100644 index 28228e6623..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMSize.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B7A675D3-EF79-4EE2-9330-D4C690739006 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsize -schema: 2.0.0 ---- - -# Get-AzureRmVMSize - -## SYNOPSIS -Gets available virtual machine sizes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListVirtualMachineSizeParamSet (Default) -``` -Get-AzureRmVMSize [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAvailableSizesForAvailabilitySet -``` -Get-AzureRmVMSize [-ResourceGroupName] <String> [-AvailabilitySetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAvailableSizesForVirtualMachine -``` -Get-AzureRmVMSize [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMSize** cmdlet gets available virtual machine sizes. - -## EXAMPLES - -### Example 1: Get virtual machine sizes for a location -``` -PS C:\> Get-AzureRmVMSize -Location "Central US" -``` - -This command gets the available sizes for virtual machines in the specified location. - -### Example 2: Get sizes for an availability set -``` -PS C:\> Get-AzureRmVMSize -ResourceGroupName "ResourceGroup03" -AvailabilitySetName "AvailabilitySet17" -``` - -This command gets available sizes for virtual machines that you can deploy in the availability set named AvailabilitySet17. - -### Example 3: Get sizes for an existing virtual machine -``` -PS C:\> Get-AzureRmVMSize -ResourceGroupName "ResourceGroup03" -VMName "VirtualMachine12" -``` - -This command gets available sizes for the existing virtual machine named VirtualMachine12. -You can resize this virtual machine to the sizes that this command gets. - -## PARAMETERS - -### -AvailabilitySetName -Specifies the name of the Availability Set for which this cmdlet gets the available virtual machine sizes. - -```yaml -Type: String -Parameter Sets: ListAvailableSizesForAvailabilitySet -Aliases: - -Required: True -Position: 1 -Default value: None -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 location for which this cmdlet gets the available virtual machine sizes. - -```yaml -Type: String -Parameter Sets: ListVirtualMachineSizeParamSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: ListAvailableSizesForAvailabilitySet, ListAvailableSizesForVirtualMachine -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that this cmdlet gets the available virtual machine sizes for resizing. - -```yaml -Type: String -Parameter Sets: ListAvailableSizesForVirtualMachine -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineSize - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMUsage.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMUsage.md deleted file mode 100644 index 03b8764864..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVMUsage.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3702701E-428D-47E2-A227-0F38B055F881 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmusage -schema: 2.0.0 ---- - -# Get-AzureRmVMUsage - -## SYNOPSIS -Gets the virtual machine core count usage for a location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVMUsage [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVMUsage** cmdlet gets the virtual machine core count usage for a location. - -## EXAMPLES - -### Example 1: Get core count usage for a location -``` -PS C:\> Get-AzureRmVMUsage -Location "Central US" -``` - -This command gets the virtual machine core count usage for the location Central US. - -## 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 location for which this cmdlet gets virtual machine core count usage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSUsage - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmss.md deleted file mode 100644 index f8a866fda4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmss.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: FC6BC096-DBC4-48DA-A366-B87EB18A0496 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmss -schema: 2.0.0 ---- - -# Get-AzureRmVmss - -## SYNOPSIS -Gets the properties of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FriendMethod -``` -Get-AzureRmVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-InstanceView] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmss** cmdlet gets the model and instance view of a Virtual Machine Scale Set (VMSS). -The model view is the user specified properties of the virtual machine. -The instance view is the instance level status of the virtual machine. -Specify the *Status* parameter to get only the instance view of a virtual machine. - -## EXAMPLES - -### Example 1: Get the properties of a VMSS -``` -PS C:\> Get-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command gets the properties of the VMSS named VMSS001 that belongs to the resource group named Group001. -Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine. - -## 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 -``` - -### -InstanceView -Indicates that this cmdlet gets only the instance view of the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssDiskEncryption.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssDiskEncryption.md deleted file mode 100644 index fce0a22aa4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssDiskEncryption.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssdiskencryption -schema: 2.0.0 ---- - -# Get-AzureRmVmssDiskEncryption - -## SYNOPSIS -Shows the disk encryption status of a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssDiskEncryption [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] - [[-ExtensionName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Shows the disk encryption status of a VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -Shows the disk encryption status of the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## 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 -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name of the virtual machine scale set - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine scale set name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVmssDiskEncryptionStatusContext - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssRollingUpgrade.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssRollingUpgrade.md deleted file mode 100644 index f1fad91dcf..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssRollingUpgrade.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssrollingupgrade -schema: 2.0.0 ---- - -# Get-AzureRmVmssRollingUpgrade - -## SYNOPSIS -Shows the status of the latest virtual machine scale set rolling upgrade. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Shows the status of the latest virtual machine scale set rolling upgrade. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command shows the status of the latest rolling upgrade of the VMSS named VMSS001 that belongs to the resource group named Group001. - -## 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRollingUpgradeStatusInfo - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssSku.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssSku.md deleted file mode 100644 index 702f102d3c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssSku.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BB6AFC7D-7E74-4D39-B336-A011B98D0682 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmsssku -schema: 2.0.0 ---- - -# Get-AzureRmVmssSku - -## SYNOPSIS -Gets the available SKUs for the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssSku [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmssSku** cmdlet gets the available SKUs for the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Get all available SKUs from the VMSS -``` -PS C:\> Get-AzureRmVmssSku -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command gets all the available SKUs from the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. - -## 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 of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### This cmdlet does not produce any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVM.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVM.md deleted file mode 100644 index f65d4b4baa..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVM.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 63D48BA4-EE80-4740-90B9-0EE05B3F6536 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssvm -schema: 2.0.0 ---- - -# Get-AzureRmVmssVM - -## SYNOPSIS -Gets the properties of a VMSS virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FriendMethod -``` -Get-AzureRmVmssVM [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [[-InstanceId] <String>] - [-InstanceView] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVmssVM** cmdlet gets the model view and instance view of a Virtual Machine Scale Set (VMSS) virtual machine. -The model view is the user specified properties of the virtual machine. -The instance view is the instance level status of the virtual machine. -Specify the *Status* parameter to get only the instance view of a virtual machine. - -## EXAMPLES - -### Example 1: Get the properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command gets the properties of the VMSS virtual machine named VMSS001 that belongs to the resource group named Group001. -Since the command does not specify the *InstanceView* switch parameter, the cmdlet gets the model view of the virtual machine. - -### Example 2: Get the model view properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -ResourceGroupName "Group002" -VMScaleSetName "VMSS004" -InstanceId $ID -``` - -This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. -The command gets the instance ID stored in the variable $ID for which to get the model view. - -### Example 3: Get the instance view properties of a VMSS virtual machine -``` -PS C:\> Get-AzureRmVmssVM -InstanceView -ResourceGroupName $rgname -VMScaleSetName $vmssName -InstanceId $ID -``` - -This command gets the properties of the VMSS virtual machine named VMSS004 that belongs to the resource group named Group002. -Since the command specifies the *InstanceView* switch parameter, the cmdlet gets the instance view of the virtual machine. -The command gets the instance ID stored in the variable $ID for which to get the instance view. - -## 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 -``` - -### -InstanceId -Specifies the instance ID for which to get the model view. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstanceView -Indicates that this cmdlet gets only the instance view of the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the Resource Group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVmssVM](./Set-AzureRmVmssVM.md) - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVMDiskEncryption.md b/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVMDiskEncryption.md deleted file mode 100644 index fcb0b1d600..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Get-AzureRmVmssVMDiskEncryption.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/get-azurermvmssvmdiskencryption -schema: 2.0.0 ---- - -# Get-AzureRmVmssVMDiskEncryption - -## SYNOPSIS -Shows the disk encryption status of VMs in a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVmssVMDiskEncryption [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-InstanceId] <String>] [-ExtensionName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Shows the disk encryption status of VM scale set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVmssVMDiskEncryption -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -InstanceId "1" -``` - -Shows the disk encryption status of VM instance 1 in the VM scale set named VMSS001 that belongs to the resource group named Group001. - -## 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 -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the instance ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource group name of the virtual machine scale set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The virtual machine scale set name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVmssVMDiskEncryptionStatusContext - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmDiskAccess.md b/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmDiskAccess.md deleted file mode 100644 index f739b0aef4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmDiskAccess.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/grant-azurermdiskaccess -schema: 2.0.0 ---- - -# Grant-AzureRmDiskAccess - -## SYNOPSIS -Grants an access to a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-Access] <AccessLevel> - [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmDiskAccess** cmdlet grants an access to a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Grant-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Access 'Read' -DurationInSecond 60; -``` - -Grant 'Read' access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' for 60 seconds. - -## PARAMETERS - -### -Access -Specifies Access level. - -```yaml -Type: AccessLevel -Parameter Sets: (All) -Aliases: -Accepted values: None, Read - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DurationInSecond -Specifies access duration in seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmSnapshotAccess.md b/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmSnapshotAccess.md deleted file mode 100644 index 8219d63823..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Grant-AzureRmSnapshotAccess.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/grant-azurermsnapshotaccess -schema: 2.0.0 ---- - -# Grant-AzureRmSnapshotAccess - -## SYNOPSIS -Grants an access to a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Grant-AzureRmSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-Access] <AccessLevel> - [[-DurationInSecond] <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Grant-AzureRmSnapshotAccess** cmdlet grants an access to a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Grant-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Access 'Read' -DurationInSecond 60; -``` - -Grant 'Read' access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' for 60 seconds. - -## PARAMETERS - -### -Access -Specifies Access level. - -```yaml -Type: AccessLevel -Parameter Sets: (All) -Aliases: -Accepted values: None, Read - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DurationInSecond -Specifies access duration in seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Invoke-AzureRmVMRunCommand.md b/azurermps-2.5.0/AzureRm.Compute/Invoke-AzureRmVMRunCommand.md deleted file mode 100644 index 18c7a8cd48..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Invoke-AzureRmVMRunCommand.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/invoke-azurermvmruncommand -schema: 2.0.0 ---- - -# Invoke-AzureRmVMRunCommand - -## SYNOPSIS -Run command on the VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Invoke-AzureRmVMRunCommand [-ResourceGroupName] <String> [-VMName] <String> -CommandId <String> - [-ScriptPath <String>] [-Parameter <Hashtable>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### VMParameter -``` -Invoke-AzureRmVMRunCommand -CommandId <String> [-ScriptPath <String>] [-Parameter <Hashtable>] - [-VM] <PSVirtualMachine> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Invoke a run command on the VM. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Invoke-AzureRmVMRunCommand -ResourceGroupName 'rgname' -Name 'vmname' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{"arg1" = "var1";"arg2" = "var2"} -``` - -Invoke a run command of RunPowerShellScript with overriding the script 'sample.ps1' and the parameters on the VM of 'vmname' in resource group 'rgname'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandId -The run command id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameter -The run command parameters. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptPath -Path of the script to be executed. When this value is given, the given script will override the default script of the command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -The PS virtual Machine Object. - -```yaml -Type: PSVirtualMachine -Parameter Sets: VMParameter -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VMName -The name of the virtual machine. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSRunCommandResult - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmAvailabilitySet.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmAvailabilitySet.md deleted file mode 100644 index 1405975e0b..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: BF6AA8D4-D624-4BE1-A393-1A43909450C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermavailabilityset -schema: 2.0.0 ---- - -# New-AzureRmAvailabilitySet - -## SYNOPSIS -Creates an Azure availability set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAvailabilitySet [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-PlatformUpdateDomainCount] <Int32>] [[-PlatformFaultDomainCount] <Int32>] [[-Sku] <String>] [-Managed] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAvailabilitySet** cmdlet creates an Azure availability set. - -## EXAMPLES - -### Example 1: Create an availability set -``` -PS C:\> New-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -Location "West US" -``` - -This command creates an availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 location for the availability set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Managed -Managed Availability Set -```yaml -Type: SwitchParameter -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 availability set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlatformFaultDomainCount -Specifies the platform fault domain count. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlatformUpdateDomainCount -Specifies the platform update domain count. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The Name of Sku -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Remove-AzureRmAvailabilitySet](./Remove-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerService.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerService.md deleted file mode 100644 index d7c5c290e1..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerService.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 522F5305-CDF6-41F2-803B-9EEA9E927668 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermcontainerservice -schema: 2.0.0 ---- - -# New-AzureRmContainerService - -## SYNOPSIS -Creates a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> - [-ContainerService] <PSContainerService> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmContainerService** cmdlet creates a container service. -Specify a container service object that you can create by using the New-AzureRmContainerServiceConfig cmdlet. - -## EXAMPLES - -### Example 1: Create a container service -``` -PS C:\> New-AzureRMResourceGroup -Name "ResourceGroup17" -Location "Australia Southeast" -Force -PS C:\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix "MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>" | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -PS C:\> New-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -ContainerService $Container -``` - -The first command creates a resource group named ResourceGroup17 at the specified location. -For more information, see the New-AzureRmResourceGroup cmdlet. - -The second command creates a container, and then stores it in the $Container variable. -For more information, see the New-AzureRmContainerServiceConfig cmdlet. - -The final command creates a container service for the container stored in $Container. -The service is named csResourceGroup17. - -## PARAMETERS - -### -AsJob -RRun cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerService -Specifies a container service object that contains the properties for the new service. -To obtain a **ContainerService** object, use the New-AzureRmContainerServiceConfig cmdlet. - -```yaml -Type: PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 -``` - -### -Name -Specifies the name of the container service that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group in which this cmdlet deploys the container service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ContainerService -Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerServiceConfig](./New-AzureRmContainerServiceConfig.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerServiceConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerServiceConfig.md deleted file mode 100644 index baa9e3040e..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmContainerServiceConfig.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EC8C915A-A0BC-41DE-9DBF-3617536E3D1A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermcontainerserviceconfig -schema: 2.0.0 ---- - -# New-AzureRmContainerServiceConfig - -## SYNOPSIS -Creates a local configuration object for a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmContainerServiceConfig [[-Location] <String>] [[-Tag] <Hashtable>] - [[-OrchestratorType] <ContainerServiceOrchestratorTypes>] [[-MasterCount] <Int32>] - [[-MasterDnsPrefix] <String>] [[-AgentPoolProfile] <ContainerServiceAgentPoolProfile[]>] - [[-WindowsProfileAdminUsername] <String>] [[-WindowsProfileAdminPassword] <String>] - [[-AdminUsername] <String>] [[-SshPublicKey] <String[]>] [[-VmDiagnosticsEnabled] <Boolean>] - [-CustomProfileOrchestrator <String>] [-ServicePrincipalProfileClientId <String>] - [-ServicePrincipalProfileSecret <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmContainerServiceConfig** cmdlet creates a local configuration object for a container service. -Provide this object to the New-AzureRmContainerService cmdlet to create a container service. - -## EXAMPLES - -### Example 1: Create a container service configuration -``` -PS C:\> $Container = New-AzureRmContainerServiceConfig -Location "Australia Southeast" -OrchestratorType "DCOS" -MasterDnsPrefix "MasterResourceGroup17" -AdminUsername "AcsLinuxAdmin" -SshPublicKey "<ssh-key>" -PS C:\> $Container | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -``` - -This command creates a container, and then stores it in the $Container variable. - -The command specifies various settings for the container service configuration. The command passes -the configuration object to the Add-AzureRmContainerServiceAgentPoolProfile cmdlet by using the -pipeline operator. That cmdlet adds an agent pool profile. - -Specify the object in $Container for the *ContainerService* parameter of **New-AzureRmContainerService**. - -## PARAMETERS - -### -AdminUsername -Specifies the administrator account name to use for a Linux-based container service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgentPoolProfile -Specifies an array of agent pool profile objects for the container service. -Add a profile by using the Add-AzureRmContainerServiceAgentPoolProfile cmdlet. - -```yaml -Type: ContainerServiceAgentPoolProfile[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomProfileOrchestrator -Specifies the custom profile orchestrator. - -```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. - -```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 location in which to create the container service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterCount -Specifies the number of master virtual machines to create. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterDnsPrefix -Specifies the DNS prefix for the master virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrchestratorType -Specifies the type of orchestrator for the container service. -The acceptable values for this parameter are: DCOS and Swarm. - -```yaml -Type: ContainerServiceOrchestratorTypes -Parameter Sets: (All) -Aliases: -Accepted values: Swarm, DCOS, Custom, Kubernetes - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalProfileClientId -Specifies the principal profile client ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalProfileSecret -Specifies the principal profile secret. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SshPublicKey -Specifies the SSH public key for a Linux-based container service. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmDiagnosticsEnabled -Indicates whether this configuration enables diagnostics for the container service virtual machine. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsProfileAdminPassword -Specifies the administrator password for a container service that uses the Windows operating system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsProfileAdminUsername -Specifies the administrator username for a container service that uses the Windows operating system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDisk.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDisk.md deleted file mode 100644 index 57c4298356..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDisk.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdisk -schema: 2.0.0 ---- - -# New-AzureRmDisk - -## SYNOPSIS -Creates a managed disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDisk** cmdlet creates a managed disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Management.Compute.Models.Disk - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskConfig.md deleted file mode 100644 index 60d01e4d1c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskConfig.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdiskconfig -schema: 2.0.0 ---- - -# New-AzureRmDiskConfig - -## SYNOPSIS -Creates a configurable disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDiskConfig [[-SkuName] <StorageAccountTypes>] [[-OsType] <OperatingSystemTypes>] - [[-DiskSizeGB] <Int32>] [[-Location] <String>] [-Zone <String[]>] [-Tag <Hashtable>] - [-CreateOption <DiskCreateOption>] [-StorageAccountId <String>] [-ImageReference <ImageDiskReference>] - [-SourceUri <String>] [-SourceResourceId <String>] [-EncryptionSettingsEnabled <Boolean>] - [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDiskConfig** cmdlet creates a configurable disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account -type. It also sets Windows OS type and enables encryption settings. The second and third commands -set the disk encryption key and key encryption key settings for the disk object. The last command -takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, -creates an empty disk, or attaches an existing disk. - -```yaml -Type: DiskCreateOption -Parameter Sets: (All) -Aliases: -Accepted values: Empty, Attach, FromImage, Import, Copy - -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a disk. - -```yaml -Type: KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReference -Specifies the image reference on a disk. - -```yaml -Type: ImageDiskReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a disk. - -```yaml -Type: KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies a location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: AccountType -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceResourceId -Specifies the source resource ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the source Uri. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the logical zone list for Disk. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskUpdateConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskUpdateConfig.md deleted file mode 100644 index 9447e80095..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmDiskUpdateConfig.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermdiskupdateconfig -schema: 2.0.0 ---- - -# New-AzureRmDiskUpdateConfig - -## SYNOPSIS -Creates a configurable disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDiskUpdateConfig [[-SkuName] <StorageAccountTypes>] [[-OsType] <OperatingSystemTypes>] - [[-DiskSizeGB] <Int32>] [[-Tag] <Hashtable>] [-EncryptionSettingsEnabled <Boolean>] - [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDiskUpdateConfig** cmdlet creates a configurable disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage -account type. It also sets Windows OS type and enables encryption settings. The second and third -commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in -resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmDiskUpdateConfig -DiskSizeGB 10 | Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -``` - -This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## 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 -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a disk. - -```yaml -Type: KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a disk. - -```yaml -Type: KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: AccountType -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImage.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImage.md deleted file mode 100644 index 0b4192baa6..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImage.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermimage -schema: 2.0.0 ---- - -# New-AzureRmImage - -## SYNOPSIS -Creates an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Image] <PSImage> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmImage** cmdlet creates an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. - -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. - -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. - -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImageConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImageConfig.md deleted file mode 100644 index bfcbee0700..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmImageConfig.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermimageconfig -schema: 2.0.0 ---- - -# New-AzureRmImageConfig - -## SYNOPSIS -Creates a configurable image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmImageConfig [[-Location] <String>] [[-Tag] <Hashtable>] [[-SourceVirtualMachineId] <String>] - [[-OsDisk] <ImageOSDisk>] [-DataDisk <ImageDataDisk[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmImageConfig** cmdlet creates a configurable image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. - -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, -$dataDiskVhdUri1, and $dataDiskVhdUri2 variables. This approach is only for readability of the -following commands. - -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. - -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -DataDisk -Specifies the data disk object. - -```yaml -Type: ImageDataDisk[] -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. - -```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 a location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDisk -Specifies the operating system Disk. - -```yaml -Type: ImageOSDisk -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVirtualMachineId -Specifies the source virtual machine ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshot.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshot.md deleted file mode 100644 index 33ec58f549..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshot.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshot -schema: 2.0.0 ---- - -# New-AzureRmSnapshot - -## SYNOPSIS -Creates a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshot** cmdlet creates a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotConfig.md deleted file mode 100644 index 58f0ff98f5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotConfig.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshotconfig -schema: 2.0.0 ---- - -# New-AzureRmSnapshotConfig - -## SYNOPSIS -Creates a configurable snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshotConfig [[-SkuName] <StorageAccountTypes>] [[-OsType] <OperatingSystemTypes>] - [[-DiskSizeGB] <Int32>] [[-Location] <String>] [-Tag <Hashtable>] [-CreateOption <DiskCreateOption>] - [-StorageAccountId <String>] [-ImageReference <ImageDiskReference>] [-SourceUri <String>] - [-SourceResourceId <String>] [-EncryptionSettingsEnabled <Boolean>] - [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshotConfig** cmdlet creates a configurable snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk. - -```yaml -Type: DiskCreateOption -Parameter Sets: (All) -Aliases: -Accepted values: Empty, Attach, FromImage, Import, Copy - -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a snapshot. - -```yaml -Type: KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReference -Specifies the image reference on a snapshot. - -```yaml -Type: ImageDiskReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a snapshot. - -```yaml -Type: KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies a location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: AccountType -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceResourceId -Specifies the source resource ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the source Uri. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the storage account ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotUpdateConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotUpdateConfig.md deleted file mode 100644 index e864dd6bd5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmSnapshotUpdateConfig.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermsnapshotupdateconfig -schema: 2.0.0 ---- - -# New-AzureRmSnapshotUpdateConfig - -## SYNOPSIS -Creates a configurable snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmSnapshotUpdateConfig [[-SkuName] <StorageAccountTypes>] [[-OsType] <OperatingSystemTypes>] - [[-DiskSizeGB] <Int32>] [[-Tag] <Hashtable>] [-EncryptionSettingsEnabled <Boolean>] - [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmSnapshotUpdateConfig** cmdlet creates a configurable snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS -storage account type. It also sets Windows OS type and enables encryption settings. The second and -third commands set the disk encryption key and key encryption key settings for the snapshot update -object. The last command takes the snapshot update object and updates an existing snapshot with -name 'Snapshot01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -``` - -This command updates an existing snapshot with name 'Snapshot01' in resource group -'ResourceGroup01' to 10 GB disk size. - -## 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 -``` - -### -DiskEncryptionKey -Specifies the disk encryption key object on a snapshot. - -```yaml -Type: KeyVaultAndSecretReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionSettingsEnabled -Enable encryption settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKey -Specifies the Key encryption key on a snapshot. - -```yaml -Type: KeyVaultAndKeyReference -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the Sku name of the storage account. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: AccountType -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVM.md deleted file mode 100644 index 1868f3ae9c..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVM.md +++ /dev/null @@ -1,605 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 05E6155D-4F0E-406B-9312-77AD97EF66EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvm -schema: 2.0.0 ---- - -# New-AzureRmVM - -## SYNOPSIS -Creates a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmVM [[-ResourceGroupName] <String>] [[-Location] <String>] -Name <String> -Credential <PSCredential> - [-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>] - [-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>] - [-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] [-ImageName <String>] - [-Size <String>] [-AvailabilitySetName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### DefaultParameterSet -``` -New-AzureRmVM [-ResourceGroupName] <String> [-Location] <String> [-VM] <PSVirtualMachine> [[-Zone] <String[]>] - [-DisableBginfoExtension] [-Tag <Hashtable>] [-LicenseType <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DiskFileParameterSet -``` -New-AzureRmVM [[-ResourceGroupName] <String>] [[-Location] <String>] -Name <String> - [-VirtualNetworkName <String>] [-AddressPrefix <String>] [-SubnetName <String>] - [-SubnetAddressPrefix <String>] [-PublicIpAddressName <String>] [-DomainNameLabel <String>] - [-AllocationMethod <String>] [-SecurityGroupName <String>] [-OpenPorts <Int32[]>] -DiskFile <String> [-Linux] - [-Size <String>] [-AvailabilitySetName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVM** cmdlet creates a virtual machine in Azure. -This cmdlet takes a virtual machine object as input. -Use the New-AzureRmVMConfig cmdlet to create a virtual machine object. -Other cmdlets can be used to configure the virtual machine, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, Add-AzureRmVMNetworkInterface, and Set-AzureRmVMOSDisk. - -The `SimpleParameterSet` provides a convenient method to create a VM by making common VM creation arguments optional. - -## EXAMPLES - -### Example 1: Create a virtual machine -``` -PS C:\> New-AzureRmVM -Name MyVm -``` - -This example script shows how to create a virtual machine. -This script uses several other cmdlets. - -### Example 2: Create a virtual machine from a custom user image -``` -PS C:\> ## VM Account -# Credentials for Local Admin account you created in the sysprepped (generalized) vhd image -$VMLocalAdminUser = "LocalAdminUser" -$VMLocalAdminSecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force -## Azure Account -$LocationName = "westus" -$ResourceGroupName = "MyResourceGroup" -# This a Premium_LRS storage account. -# It is required in order to run a client VM with efficiency and high performance. -$StorageAccount = "Mydisk" - -## VM -$OSDiskName = "MyClient" -$ComputerName = "MyClientVM" -$OSDiskUri = "https://Mydisk.blob.core.windows.net/disks/MyOSDisk.vhd" -$SourceImageUri = "https://Mydisk.blob.core.windows.net/vhds/MyOSImage.vhd" -$VMName = "MyVM" -# Modern hardware environment with fast disk, high IOPs performance. -# Required to run a client VM with efficiency and performance -$VMSize = "Standard_DS3" -$OSDiskCaching = "ReadWrite" -$OSCreateOption = "FromImage" - -## Networking -$DNSNameLabel = "mydnsname" # mydnsname.westus.cloudapp.azure.com -$NetworkName = "MyNet" -$NICName = "MyNIC" -$PublicIPAddressName = "MyPIP" -$SubnetName = "MySubnet" -$SubnetAddressPrefix = "10.0.0.0/24" -$VnetAddressPrefix = "10.0.0.0/16" - -$SingleSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name $SubnetName -AddressPrefix $SubnetAddressPrefix -$Vnet = New-AzureRmVirtualNetwork -Name $NetworkName -ResourceGroupName $ResourceGroupName -Location $LocationName -AddressPrefix $VnetAddressPrefix -Subnet $SingleSubnet -$PIP = New-AzureRmPublicIpAddress -Name $PublicIPAddressName -DomainNameLabel $DNSNameLabel -ResourceGroupName $ResourceGroupName -Location $LocationName -AllocationMethod Dynamic -$NIC = New-AzureRmNetworkInterface -Name $NICName -ResourceGroupName $ResourceGroupName -Location $LocationName -SubnetId $Vnet.Subnets[0].Id -PublicIpAddressId $PIP.Id - -$Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdminUser, $VMLocalAdminSecurePassword); - -$VirtualMachine = New-AzureRmVMConfig -VMName $VMName -VMSize $VMSize -$VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -ProvisionVMAgent -EnableAutoUpdate -$VirtualMachine = Add-AzureRmVMNetworkInterface -VM $VirtualMachine -Id $NIC.Id -$VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name $OSDiskName -VhdUri $OSDiskUri -SourceImageUri $SourceImageUri -Caching $OSDiskCaching -CreateOption $OSCreateOption -Windows - -New-AzureRmVM -ResourceGroupName $ResourceGroupName -Location $LocationName -VM $VirtualMachine -Verbose -``` - -This example takes an existing sys-prepped, generalized custom operating system image and attaches a data disk to it, provisions a new network, deploys the VHD, and runs it. - -This script can be used for automatic provisioning because it uses the local virtual machine admin credentials inline instead of calling **Get-Credential** which requires user interaction. - -This script assumes that you are already logged into your Azure account. -You can confirm your login status by using the **Get-AzureSubscription** cmdlet. - -## PARAMETERS - -### -AddressPrefix -The address prefix for the virtual network which will be created for the VM. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.0.0/16 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllocationMethod -The IP allocation method for the public IP which will be created for the VM. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: -Accepted values: Static, Dynamic - -Required: False -Position: Named -Default value: Static -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySetName -Specifies a name for the availability set. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The administrator credentials for the VM. - -```yaml -Type: PSCredential -Parameter Sets: SimpleParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableBginfoExtension -Indicates that this cmdlet does not install the **BG Info** extension on the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskFile -The local path to the virtual hard disk file to be uploaded to the cloud and for creating the VM, and it must have '.vhd' as its suffix. - -```yaml -Type: String -Parameter Sets: DiskFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -The subdomain label for the fully-qualified domain name (FQDN) of the VM. This will take the form `{domainNameLabel}.{location}.cloudapp.azure.com`. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -The friendly image name upon which the VM will be built. These include: Win2016Datacenter, Win2012R2Datacenter, Win2012Datacenter, Win2008R2SP1, UbuntuLTS, CentOS, CoreOS, Debian, openSUSE-Leap, RHEL, SLES. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: Win2016Datacenter -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Specifies a license type, which indicates that the image or disk for the virtual machine was licensed on-premises. -This value is used only for images that contain the Windows Server operating system. -The acceptable values for this parameter are: - -- Windows_Client -- Windows_Server - -This value cannot be updated. -If you specify this parameter for an update, the value must match the initial value for the virtual machine. - -```yaml -Type: String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates whether the disk file is for Linux VM, if specified; or Windows, if not specified by default. - -```yaml -Type: SwitchParameter -Parameter Sets: DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies a location for the virtual machine. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the VM resource. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OpenPorts -A list of ports to open on the network security group (NSG) for the created VM. The default value depends on the type of image chosen (i.e., Windows: 3389, 5985 and Linux: 22). - -```yaml -Type: Int32[] -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressName -The name of a new (or existing) public IP address for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: DefaultParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecurityGroupName -The name of a new (or existing) network security group (NSG) for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -The Virtual Machine Size. The Default Value is: Standard_DS1_v2. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: Standard_DS1_v2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetAddressPrefix -The address prefix for the subnet which will be created for the VM. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.1.0/24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetName -The name of a new (or existing) subnet for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Specifies that resources and resource groups can be tagged with a set of name-value pairs. -Adding tags to resources enables you to group resources together across resource groups and to create your own views. -Each resource or resource group can have a maximum of 15 tags. - -```yaml -Type: Hashtable -Parameter Sets: DefaultParameterSet -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The name of a new (or existing) virtual network for the created VM to use. If not specified, a name will be generated. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet, DiskFileParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine to create. -To obtain a virtual machine object, use the New-AzureRmVMConfig cmdlet. -Other cmdlets can be used to configure the virtual machine, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, and Add-AzureRmVMNetworkInterface. - -```yaml -Type: PSVirtualMachine -Parameter Sets: DefaultParameterSet -Aliases: VMProfile - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list of the virtual machine. - -```yaml -Type: String[] -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: 3 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - -[Add-AzureRmVMDataDisk](./Add-AzureRmVMDataDisk.md) - -[Add-AzureRmVMNetworkInterface](./Add-AzureRmVMNetworkInterface.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[Set-AzureRmVMSourceImage](./Set-AzureRmVMSourceImage.md) - -[Set-AzureRmVMOSDisk](./Set-AzureRmVMOSDisk.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMConfig.md deleted file mode 100644 index 0e12ca56e1..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMConfig.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1BECAC91-BB43-46EB-B2C9-C965C6FBC831 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmconfig -schema: 2.0.0 ---- - -# New-AzureRmVMConfig - -## SYNOPSIS -Creates a configurable virtual machine object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-Zone <String[]>] [-Tags <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-IdentityType] <ResourceIdentityType> [-IdentityId <String[]>] [-Zone <String[]>] - [-Tags <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -New-AzureRmVMConfig [-VMName] <String> [-VMSize] <String> [[-AvailabilitySetId] <String>] - [[-LicenseType] <String>] [-AssignIdentity] [-Zone <String[]>] [-Tags <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMConfig** cmdlet creates a configurable local virtual machine object for Azure. -Other cmdlets can be used to configure a virtual machine object, such as Set-AzureRmVMOperatingSystem, Set-AzureRmVMSourceImage, Add-AzureRmVMNetworkInterface, and Set-AzureRmVMOSDisk. - -## EXAMPLES - -### Example 1: Create a virtual machine object -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. - -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. - -## PARAMETERS - -### -AssignIdentity -Specify the system assigned identity for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySetId -Specifies the ID of an availability set. -To obtain an availability set object, use the Get-AzureRmAvailabilitySet cmdlet. -The availability set object contains an ID property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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 -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityType -The identity of the virtual machine, if configured. - -```yaml -Type: ResourceIdentityType -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -The license type, which is for bringing your own license scenario. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -The tags attached to the resource. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tag - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies a name for the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMSize -Specifies the size for the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list for the virtual machine. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Update-AzureRmVM](./Update-AzureRmVM.md) - -[Set-AzureRmVMOperatingSystem](./Set-AzureRmVMOperatingSystem.md) - -[Set-AzureRmVMSourceImage](./Set-AzureRmVMSourceImage.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md deleted file mode 100644 index 516d4c1867..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoBackupConfig.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 0AC17275-17A9-47DE-BF04-C1A51DF057DC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverautobackupconfig -schema: 2.0.0 ---- - -# New-AzureRmVMSqlServerAutoBackupConfig - -## SYNOPSIS -Creates a configuration object for SQL Server automatic backup. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StorageUriSqlServerAutoBackup (Default) -``` -New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] - [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption] [[-CertificatePassword] <SecureString>] - [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>] - [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>] - [-LogBackupFrequencyInMinutes <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### StorageContextSqlServerAutoBackup -``` -New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] - [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption] [[-CertificatePassword] <SecureString>] - [[-StorageContext] <IStorageContext>] [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] - [-BackupScheduleType <String>] [-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] - [-FullBackupWindowInHours <Int32>] [-LogBackupFrequencyInMinutes <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMSqlServerAutoBackupConfig** cmdlet creates a configuration object for SQL Server automatic backup. - -## EXAMPLES - -### Example 1: Create an automatic backup configuration using storage URI and account key -``` -PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri "\\contoso\StorageGeneral" -StorageKey "< Storage Key for ContosoGeneral >" -Enable : True -EnableEncryption : False -RetentionPeriodInDays : 10 -``` - -This command creates an automatic backup configuration object by specifying storage URI and account key. -Automatic backup is enabled and automatic backups are kept for 10 days. -The command stores the result in the $AutoBackupConfig variable. -You can specify this configuration item for other cmdlets, such as the Set-AzureRmVMSqlServerExtension cmdlet. - -### Example 2: Create an automatic backup configuration using storage context -``` -PS C:\> $StorageContext = New-AzureStorageContext -StorageAccountName "ContosoGeneral" -StorageAccountKey "< Storage Key for ContosoGeneral >" -PS C:\> $AutoBackupConfig = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10 -Enable : True -EnableEncryption : False -RetentionPeriodInDays : 10 -``` - -The first command creates a storage context, and then stores it in the $StorageContext variable. -For more information, see New-AzureStorageContext. - -The second command creates an automatic backup configuration object by specifying the storage context in $StorageContext. -Automatic backup is enabled and automatic backups are kept for 10 days. - -### Example 3: Create an automatic backup configuration using storage context with encryption and password -``` -PS C:\> $StorageContext = New-AzureRmVMSqlServerAutoBackupConfig -StorageContext $StorageContext -Enable -RetentionPeriod 10 -EnableEncryption -CertificatePassword $CertificatePassword -Enable : True -EnableEncryption : True -RetentionPeriodInDays : 10 -``` - -This command creates and stores an automatic backup configuration object. -The command specifies the storage context created in a previous example. -The command enables encryption with password. -The password was previously stored as a secure string in the $CertificatePassword variable. -To create a secure string, use the ConvertTo-SecureString cmdlet. - -## PARAMETERS - -### -BackupScheduleType -Backup schedule type, manual or automated - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Manual, Automated - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupSystemDbs -Backup system databases - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies a password to encrypt the certificate that is used to perform SQL Server encrypted backups. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that automated backup for the SQL Server virtual machine is enabled. -If you specify this parameter, automated backup sets a backup schedule for all current and new databases. -This updates your Managed Backup settings to follow this schedule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableEncryption -Indicates that this cmdlet enables encryption. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupFrequency -Sql Server Full Backup frequency, daily or weekly - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Daily, Weekly - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupStartHour -Hour of the day (0-23) when the Sql Server Full Backup should start - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullBackupWindowInHours -Sql Server Full Backup window in hours - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogBackupFrequencyInMinutes -Sql Server Log Backup frequency, once every 1-60 minutes - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionPeriodInDays -Specifies the number of days to retain a backup. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies the storage account that will be used to store backups. -To obtain an **AzureStorageContext** object, use the New-AzureStorageContext cmdlet. -The default is the storage account that is associated with the SQL Server virtual machine. - -```yaml -Type: IStorageContext -Parameter Sets: StorageContextSqlServerAutoBackup -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the storage key of the blob storage account. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageUri -Specifies the Uniform Resource Identifier (URI) of the blob storage account. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.AutoBackupSettings - -## NOTES - -## RELATED LINKS - - - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md deleted file mode 100644 index 7590faff63..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerAutoPatchingConfig.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7016BAA9-C25D-404E-9F75-2BE49FBF91A8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverautopatchingconfig -schema: 2.0.0 ---- - -# New-AzureRmVMSqlServerAutoPatchingConfig - -## SYNOPSIS -Creates a configuration object for automatic patching on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVMSqlServerAutoPatchingConfig [-Enable] [-DayOfWeek <String>] - [-MaintenanceWindowStartingHour <Int32>] [-MaintenanceWindowDuration <Int32>] [-PatchCategory <String>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVMSqlServerAutoPatchingConfig** cmdlet creates a configuration object for automatic patching on a virtual machine. - -## EXAMPLES - -### Example 1: Create a configuration object to configure automatic patching -``` -PS C:\> $AutoPatchingConfig = New-AzureRmVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" -Enable : True -DayOfWeek : Thursday -MaintenanceWindowStartingHour : 11 -MaintenanceWindowDuration : 120 -PatchCategory : Important -``` - -This command creates configuration object for patching. -The command specifies the day of the week and defines the maintenance window. -This configuration enables patching that uses these values. -The command stores the result in the $AutoBackupConfig variable. -You can specify this configuration item for other cmdlets, such as the Set-AzureRmVMSqlServerExtension cmdlet. - -## PARAMETERS - -### -DayOfWeek -Specifies the day of the week when updates should be installed. - -The acceptable values for this parameter are: - -- Sunday -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Everyday - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Everyday - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that automated patching for the virtual machine is enabled. -If you enable automated patching the cmdlet puts Windows Update into interactive mode. -If you disable automated patching, Windows Update settings do not change. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceWindowDuration -Specifies the duration, in minutes, of the maintenance window. -Automated patching avoids performing an action that can affect a virtual machine availability outside that window. -Specify a multiple of 30 minutes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaintenanceWindowStartingHour -Specifies the hour of the day when maintenance window starts. -This time defines when updates start to install. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PatchCategory -Specifies whether important updates should be included. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Important - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### AutoPatchingSettings -This cmdlet returns object contains settings for automated patching. - -## NOTES - -## RELATED LINKS - - - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md deleted file mode 100644 index a0d8bcd220..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B30C2BDD-6DA9-47B5-88FE-3AD43E15A072 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmsqlserverkeyvaultcredentialconfig -schema: 2.0.0 ---- - -# New-AzureRmVMSqlServerKeyVaultCredentialConfig - -## SYNOPSIS -Creates a configuration object for SQL server key vault credential on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVMSqlServerKeyVaultCredentialConfig [-ResourceGroupName] <String> [-Enable] - [-CredentialName <String>] [-AzureKeyVaultUrl <String>] [-ServicePrincipalName <String>] - [-ServicePrincipalSecret <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -## PARAMETERS - -### -AzureKeyVaultUrl -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CredentialName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalSecret -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.KeyVaultCredentialSettings - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmss.md deleted file mode 100644 index 9b64d7ed60..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmss.md +++ /dev/null @@ -1,611 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 1A2C843C-6962-4B0E-ACBF-A5EFF609A5BE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmss -schema: 2.0.0 ---- - -# New-AzureRmVmss - -## SYNOPSIS -Creates a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -New-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SimpleParameterSet -``` -New-AzureRmVmss [[-ResourceGroupName] <String>] [-VMScaleSetName] <String> [-AsJob] [-ImageName <String>] - -Credential <PSCredential> [-InstanceCount <Int32>] [-VirtualNetworkName <String>] [-SubnetName <String>] - [-PublicIpAddressName <String>] [-DomainNameLabel <String>] [-SecurityGroupName <String>] - [-LoadBalancerName <String>] [-BackendPort <Int32[]>] [-Location <String>] [-VmSize <String>] - [-UpgradePolicyMode <UpgradeMode>] [-AllocationMethod <String>] [-VnetAddressPrefix <String>] - [-SubnetAddressPrefix <String>] [-FrontendPoolName <String>] [-BackendPoolName <String>] - [-Zone <System.Collections.Generic.List`1[System.String]>] [-NatBackendPort <Int32[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmss** cmdlet creates a Virtual Machine Scale Set (VMSS) in Azure. -This cmdlet takes a **VirtualMachineScaleSet** object as input. - -## EXAMPLES - -### Example 1: Create a VMSS -``` -# Common -$LOC = "WestUs"; -$RGName = "rgkyvms"; - -New-AzureRmResourceGroup -Name $RGName -Location $LOC -Force; - -# SRP -$STOName = "STO" + $RGName; -$STOType = "Standard_GRS"; -New-AzureRmStorageAccount -ResourceGroupName $RGName -Name $STOName -Location $LOC -Type $STOType; -$STOAccount = Get-AzureRmStorageAccount -ResourceGroupName $RGName -Name $STOName; - -# NRP -$SubNet = New-AzureRmVirtualNetworkSubnetConfig -Name ("subnet" + $RGName) -AddressPrefix "10.0.0.0/24"; -$VNet = New-AzureRmVirtualNetwork -Force -Name ("vnet" + $RGName) -ResourceGroupName $RGName -Location $LOC -AddressPrefix "10.0.0.0/16" -DnsServer "10.1.1.1" -Subnet $SubNet; -$VNet = Get-AzureRmVirtualNetwork -Name ('vnet' + $RGName) -ResourceGroupName $RGName; -$SubNetId = $VNet.Subnets[0].Id; - -$PubIP = New-AzureRmPublicIpAddress -Force -Name ("PubIP" + $RGName) -ResourceGroupName $RGName -Location $LOC -AllocationMethod Dynamic -DomainNameLabel ("PubIP" + $RGName); -$PubIP = Get-AzureRmPublicIpAddress -Name ("PubIP" + $RGName) -ResourceGroupName $RGName; - -# Create LoadBalancer -$FrontendName = "fe" + $RGName -$BackendAddressPoolName = "bepool" + $RGName -$ProbeName = "vmssprobe" + $RGName -$InboundNatPoolName = "innatpool" + $RGName -$LBRuleName = "lbrule" + $RGName -$LBName = "vmsslb" + $RGName - -$Frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name $FrontendName -PublicIpAddress $PubIP -$BackendAddressPool = New-AzureRmLoadBalancerBackendAddressPoolConfig -Name $BackendAddressPoolName -$Probe = New-AzureRmLoadBalancerProbeConfig -Name $ProbeName -RequestPath healthcheck.aspx -Protocol http -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -$InboundNatPool = New-AzureRmLoadBalancerInboundNatPoolConfig -Name $InboundNatPoolName -FrontendIPConfigurationId ` - $Frontend.Id -Protocol Tcp -FrontendPortRangeStart 3360 -FrontendPortRangeEnd 3362 -BackendPort 3370; -$LBRule = New-AzureRmLoadBalancerRuleConfig -Name $LBRuleName ` - -FrontendIPConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` - -Probe $Probe -Protocol Tcp -FrontendPort 80 -BackendPort 80 ` - -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP; -$ActualLb = New-AzureRmLoadBalancer -Name $LBName -ResourceGroupName $RGName -Location $LOC ` - -FrontendIpConfiguration $Frontend -BackendAddressPool $BackendAddressPool ` - -Probe $Probe -LoadBalancingRule $LBRule -InboundNatPool $InboundNatPool; -$ExpectedLb = Get-AzureRmLoadBalancer -Name $LBName -ResourceGroupName $RGName - -# New VMSS Parameters -$VMSSName = "VMSS" + $RGName; - -$AdminUsername = "Admin01"; -$AdminPassword = "p4ssw0rd@123" + $RGName; - -$PublisherName = "MicrosoftWindowsServer" -$Offer = "WindowsServer" -$Sku = "2012-R2-Datacenter" -$Version = "latest" - -$VHDContainer = "https://" + $STOName + ".blob.core.contoso.net/" + $VMSSName; - -$ExtName = "CSETest"; -$Publisher = "Microsoft.Compute"; -$ExtType = "BGInfo"; -$ExtVer = "2.1"; - -#IP Config for the NIC -$IPCfg = New-AzureRmVmssIPConfig -Name "Test" ` - -LoadBalancerInboundNatPoolsId $ExpectedLb.InboundNatPools[0].Id ` - -LoadBalancerBackendAddressPoolsId $ExpectedLb.BackendAddressPools[0].Id ` - -SubnetId $SubNetId; - -#VMSS Config -$VMSS = New-AzureRmVmssConfig -Location $LOC -SkuCapacity 2 -SkuName "Standard_A2" -UpgradePolicyMode "Automatic" ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test2" -IPConfiguration $IPCfg ` - | Set-AzureRmVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword ` - | Set-AzureRmVmssStorageProfile -Name "Test" -OsDiskCreateOption 'FromImage' -OsDiskCaching "None" ` - -ImageReferenceOffer $Offer -ImageReferenceSku $Sku -ImageReferenceVersion $Version ` - -ImageReferencePublisher $PublisherName -VhdContainer $VHDContainer ` - | Add-AzureRmVmssExtension -Name $ExtName -Publisher $Publisher -Type $ExtType -TypeHandlerVersion $ExtVer -AutoUpgradeMinorVersion $True - -#Create the VMSS -New-AzureRmVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; -``` - -The following complex example creates a VMSS. -The first command creates a resource group with the specified name and location. -The second command uses the **New-AzureRmStorageAccount** cmdlet to create a storage account. -The third command then uses the **Get-AzureRmStorageAccount** cmdlet to get the storage account created in the second command and stores the result in the $STOAccount variable. -The fifth command uses the **New-AzureRmVirtualNetworkSubnetConfig** cmdlet to create a subnet and stores the result in the variable named $SubNet. -The sixth command uses the **New-AzureRmVirtualNetwork** cmdlet to create a virtual network and stores the result in the variable named $VNet. -The seventh command uses the **Get-AzureRmVirtualNetwork** to get information about the virtual network created in the sixth command and stores the information in the variable named $VNet. -The eighth and ninth command uses the **New-AzureRmPublicIpAddress** and **Get- AzureRmPublicIpAddress** to create and get information from that public IP address. -The commands store the information in the variable named $PubIP. -The tenth command uses the **New- AzureRmLoadBalancerFrontendIpConfig** cmdlet to create a frontend load balancer and stores the result in the variable named $Frontend. -The eleventh command uses the **New-AzureRmLoadBalancerBackendAddressPoolConfig** to create a backend address pool configuration and stores the result in the variable named $BackendAddressPool. -The twelfth command uses the **New-AzureRmLoadBalancerProbeConfig** to create a probe and stores the probe information in the variable named $Probe. -The thirteenth command uses the **New-AzureRmLoadBalancerInboundNatPoolConfig** cmdlet to create a load balancer inbound network address translation (NAT) pool configuration. -The fourteenth command uses the **New-AzureRmLoadBalancerRuleConfig** to create a load balancer rule configuration and stores the result in the variable named $LBRule. -The fifteenth command uses the **New-AzureRmLoadBalancer** cmdlet to create a load balancer and stores the result in the variable named $ActualLb. -The sixteenth command uses the **Get-AzureRmLoadBalancer** to get information about the load balancer that was created in the fifteenth command and stores the information in the variable named $ExpectedLb. -The seventeenth command uses the **New-AzureRmVmssIPConfig** cmdlet to create a VMSS IP configuration and stores the information in the variable named $IPCfg. -The eighteenth command uses the **New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. -The nineteenth command uses the **New-AzureRmVmss** cmdlet to create the VMSS. - -## PARAMETERS - -### -AllocationMethod -Allocation method for the Public IP Address of the Scale Set (Static or Dynamic). If no value is supplied, allocation will be static. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: -Accepted values: Static, Dynamic - -Required: False -Position: Named -Default value: Static -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPoolName -The name of the backend address pool to use in the load balancer for this Scale Set. If no value is provided, a new backend pool will be created, with the same name as the Scale Set. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPort -Backend port numbers used by the Scale Set load balancer to communicate with VMs in the Scale Set. If no values are specified, ports 3389 and 5985 will be used for Windows VMS, and port 22 will be used for Linux VMs. - -```yaml -Type: Int32[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The administrator credentials (username and password) for VMs in this Scale Set. - -```yaml -Type: PSCredential -Parameter Sets: SimpleParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -The domain name label for the public Fully-Qualified domain name (FQDN) for this Scale Set. This is the first component of the domain name that is automatically assigned to the Scale Set. Automatically assigned Domain names use the form (`<DomainNameLabel>.<Location>.cloudapp.azure.com`). If no value is supplied, the default domain name label will be the concatenation of `<ScaleSetName>` and `<ResourceGroupName>`. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPoolName -The name of the frontend address pool to use in the Scale Set load balancer. If no value is supplied, a new Frontend Address Pool will be created, with the same name as the scale set. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -The name of the image for VMs in this Scale Set. If no value is provided, the "Windows Server 2016 DataCenter" image will be used. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceCount -The number of VM images in the Scale Set. If no value is provided, 2 instances will be created. - -```yaml -Type: Int32 -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerName -The name of the load balancer to use with this Scale Set. A new load balancer using the same name as the Scale Set will be created if no value is specified. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Azure location where this Scale Set will be created. If no value is specified, the location will be inferred from the location of other resources referenced in the parameters. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NatBackendPort -Backend port for inbound network address translation. - -```yaml -Type: Int32[] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressName -The name of the public IP Address to use with this scale set. A new Public IPAddress with the same name as the Scale Set will be created if no value is provided. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -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 VMSS. If no value is specified, a new ResourceGroup will be created using the same name as the Scale Set. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityGroupName -The name of the network security group to apply to this Scale Set. If no value is provided, a default network security group with the same name as the Scale Set will be created and applied to the Scale Set. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetAddressPrefix -The address prefix of the Subnet this ScaleSet will use. Default Subnet settings (192.168.1.0/24) will be applied if no value is provided. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.1.0/24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetName -The name of the subnet to use with this Scale Set. A new Subnet will be created with the same name as the Scale Set if no value is provided. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -The upgrade policy mode for VM instances in this Scale Set. Upgrade policy could specify Automatic, Manual, or Rolling upgrades. - -```yaml -Type: UpgradeMode -Parameter Sets: SimpleParameterSet -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the **VirtualMachineScaleSet** object that contains the properties of the VMSS that this cmdlet creates. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The name fo the Virtual Network to use with this scale set. If no value is supplied, a new virtual network with the same name as the Scale Set will be created. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmSize -The size of the VM instances in this scale set. A default size (Standard_DS1_v2) will be used if no Size is specified. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: Standard_DS1_v2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VnetAddressPrefix -The address prefix for the virtual network used with this Scale Set. Default virtual network address prefix settings (192.168.0.0/16) will be used if no value is supplied. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: 192.168.0.0/16 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssConfig.md deleted file mode 100644 index 091b6f2521..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssConfig.md +++ /dev/null @@ -1,575 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CE32F620-8DB2-4004-8012-F1C4AA235B60 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssconfig -schema: 2.0.0 ---- - -# New-AzureRmVmssConfig - -## SYNOPSIS -Creates a VMSS configuration object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-Zone <String[]>] - [-PlanName <String>] [-PlanPublisher <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] - [-RollingUpgradePolicy <RollingUpgradePolicy>] [-AutoOSUpgrade] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-Zone <String[]>] - [-PlanName <String>] [-PlanPublisher <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] - [-RollingUpgradePolicy <RollingUpgradePolicy>] [-AutoOSUpgrade] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] - -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -New-AzureRmVmssConfig [[-Overprovision] <Boolean>] [[-Location] <String>] [[-Tag] <Hashtable>] - [[-SkuName] <String>] [[-SkuTier] <String>] [[-SkuCapacity] <Int32>] [[-UpgradePolicyMode] <UpgradeMode>] - [[-OsProfile] <VirtualMachineScaleSetOSProfile>] [[-StorageProfile] <VirtualMachineScaleSetStorageProfile>] - [[-NetworkInterfaceConfiguration] <VirtualMachineScaleSetNetworkConfiguration[]>] - [[-Extension] <VirtualMachineScaleSetExtension[]>] [-SinglePlacementGroup <Boolean>] [-Zone <String[]>] - [-PlanName <String>] [-PlanPublisher <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] - [-RollingUpgradePolicy <RollingUpgradePolicy>] [-AutoOSUpgrade] [-HealthProbeId <String>] - [-BootDiagnostic <BootDiagnostics>] [-LicenseType <String>] [-Priority <String>] [-AssignIdentity] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssConfig** cmdlet creates a configurable local Virtual Manager Scale Set (VMSS) -object. Other cmdlets are needed to configure the VMSS object. These cmdlets are: - -- Set-AzureRmVmssOsProfile -- Set-AzureRmVmssStorageProfile -- Add-AzureRmVmssNetworkInterfaceConfiguration -- Add-AzureRmVmssExtension - -## EXAMPLES - -### Example 1: Create a VMSS configuration object -``` -PS C:\> $VMSS = New-AzureRmVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic" -NetworkInterfaceConfiguration $NetCfg ` - | Add-AzureRmVmssNetworkInterfaceConfiguration -Name "Test" -Primary $True -IPConfiguration $IPCfg ` - | Set-AzureRmVmssOSProfile -ComputerNamePrefix "Test" -AdminUsername $adminUsername -AdminPassword $AdminPassword ` - | Set-AzureRmVmssStorageProfile -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` - -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` - -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VHDContainer ` - | Add-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName -Content $AUCContent -PassName $AUCPassName -SettingName $AUCSetting ` - | Remove-AzureRmVmssAdditionalUnattendContent -ComponentName $AUCComponentName; - -New-AzureRmVmss -ResourceGroupName $RGName -Name $VMSSName -VirtualMachineScaleSet $VMSS; -``` - -This example creates a VMSS configuration object. The first command uses the -**New-AzureRmVmssConfig** cmdlet to create a VMSS configuration object and stores the result in the -variable named $VMSS. The second command uses the **New-AzureRmVmss** cmdlet to create a VMSS that -uses the VMSS configuration object created in the first command. - -## PARAMETERS - -### -AssignIdentity -Specify the system assigned identity for the virtual machine scale set. - -```yaml -Type: SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoOSUpgrade -Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnostic -Specifies the virtual machine scale set boot diagnostics profile. - -```yaml -Type: BootDiagnostics -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the extension information object for the VMSS. You can use the -**Add-AzureRmVmssExtension** cmdlet to add this object. - -```yaml -Type: VirtualMachineScaleSetExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HealthProbeId -Specifies the ID of a load balancer probe used to determine the health of an instance in the virtual machine scale set. -HealthProbeId is in the form of '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityType -Specifies the type of identity used for the virtual machine scale set. -The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. -The type 'None' will remove any identities from the virtual machine scale set. -The acceptable values for this parameter are: - -- SystemAssigned -- UserAssigned -- SystemAssignedUserAssigned -- None - -```yaml -Type: ResourceIdentityType -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LicenseType -Specify the license type, which is for bringing your own license scenario. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure location where the VMSS is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterfaceConfiguration -Specifies the network profile object that contains the networking properties for the VMSS configuration. -You can use the **Add-AzureRmVmssNetworkInterfaceConfiguration** cmdlet to add this object. - -```yaml -Type: VirtualMachineScaleSetNetworkConfiguration[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsProfile -Specifies the operating system profile object that contains the operating system properties for the VMSS configuration. -You can use the **Set-AzureRmVmssOsProfile** cmdlet to set this object. - -```yaml -Type: VirtualMachineScaleSetOSProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overprovision -Indicates whether the cmdlet overprovisions the VMSS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanName -Specifies the plan name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanProduct -Specifies the plan product. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanPromotionCode -Specifies the plan promotion code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PlanPublisher -Specifies the plan publisher. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for the virtual machines in the scale set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollingUpgradePolicy -Specifies the rolling upgrade policy. - -```yaml -Type: RollingUpgradePolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SinglePlacementGroup -Specifies the single placement group. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuCapacity -Specifies the number of instances in the VMSS. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the size of all the instances of VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: AccountType - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -Specifies the tier of VMSS. The acceptable values for this parameter are: - -- Standard -- Basic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageProfile -Specifies the storage profile object that contains the disk properties for the VMSS configuration. -You can use the **Set-AzureRmVmssStorageProfile** cmdlet to set this object. - -```yaml -Type: VirtualMachineScaleSetStorageProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -Specified the mode of an upgrade to virtual machines in the scale set. - -The acceptable values for this parameter are: - -- Automatic -- Manual - -```yaml -Type: UpgradeMode -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the zone list for the virtual machine scale set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Set-AzureRmVmssOsProfile](./Set-AzureRmVmssOsProfile.md) - -[Set-AzureRmVmssStorageProfile](./Set-AzureRmVmssStorageProfile.md) - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssIpConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssIpConfig.md deleted file mode 100644 index b8aee94012..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssIpConfig.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 92F192A5-F75E-4EFE-B2D2-B0DF0B78D3B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssipconfig -schema: 2.0.0 ---- - -# New-AzureRmVmssIpConfig - -## SYNOPSIS -Creates an IP configuration for a network interface of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVmssIpConfig [[-Name] <String>] [[-Id] <String>] [[-SubnetId] <String>] - [[-ApplicationGatewayBackendAddressPoolsId] <String[]>] [[-LoadBalancerBackendAddressPoolsId] <String[]>] - [[-LoadBalancerInboundNatPoolsId] <String[]>] [-Primary] [-PrivateIPAddressVersion <String>] - [-PublicIPAddressConfigurationName <String>] [-PublicIPAddressConfigurationIdleTimeoutInMinutes <Int32>] - [-DnsSetting <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssIpConfig** cmdlet creates an IP configuration object for a network interface of a Virtual Machine Scale Set (VMSS). -Specify the configuration from this cmdlet as the *IPConfiguration* parameter of the Add-AzureRmVmssNetworkInterfaceConfiguration cmdlet. - -## EXAMPLES - -### Example 1: Create an IP configuration object for a VMSS interface -``` -PS C:\> $IPConfiguration = New-AzureRmVmssIPConfig -Name "ContosoVmssInterface02" -SubnetId $SubnetId -``` - -This command creates an IP configuration object named ContosoVmssInterface02. -The command uses a previously defined subnet ID stored in $SubnetId. -The command stores the configuration settings in the $IPConfiguration variable for later use with **Add-AzureRmVmssNetworkInterfaceConfiguration**. - -### Example 2: Create an IP configuration object that includes NAT pool settings -``` -PS C:\> $IPConfiguration = New-AzureRmVmssIPConfig -Name "ContosoVmssInterface03" -LoadBalancerInboundNatPoolsId $expectedLb.InboundNatPools[0].Id -LoadBalancerBackendAddressPoolsId $expectedLb.BackendAddressPools[0].Id -SubnetId $SubnetId -``` - -This command creates an IP configuration object named ContosoVmssInterface03, and then stores it in the $IPConfiguration variable for later use. -The command uses a previously defined subnet ID stored in $SubnetId. -The command stores the configuration settings in the $IPConfiguration variable for later use. -The command specifies values for the *LoadBalancerInboundNatPoolsId* and *LoadBalancerBackendAddressPoolsId* parameters. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPoolsId -Specifies an array of references to backend address pools of load balancers. -A scale set can reference backend address pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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 -``` - -### -DnsSetting -The dns settings to be applied on the publicIP addresses. -The domain name label of the Dns settings to be applied on the publicIP addresses. -The concatenation of the domain name label and vm index will be the domain name labels of the Public IP Address resources that will be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PublicIPAddressDomainNameLabel - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies an ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolsId -Specifies an array of references to incoming network address translation (NAT) pools of the load balancers. -A scale set can reference incoming NAT pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatPoolsId -Specifies an array of references to incoming NAT pools of the load balancers. -A scale set can reference incoming NAT pools of one public and one internal load balancer. -Multiple scale sets cannot use the same load balancer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Primary -Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddressVersion -Specify the ip configuration is either IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIPAddressConfigurationIdleTimeoutInMinutes -The idle timeout of the public IP address. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: PublicIPAddressIdleTimeoutInMinutes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIPAddressConfigurationName -The publicIP address configuration name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PublicIPAddressName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID in which the configuration creates the VMSS network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSetIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssVaultCertificateConfig.md b/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssVaultCertificateConfig.md deleted file mode 100644 index 529be5727b..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/New-AzureRmVmssVaultCertificateConfig.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5CC89899-00B6-424A-8896-FD32DE9DDA28 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/new-azurermvmssvaultcertificateconfig -schema: 2.0.0 ---- - -# New-AzureRmVmssVaultCertificateConfig - -## SYNOPSIS -Creates a Key Vault certificate configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVmssVaultCertificateConfig [[-CertificateUrl] <String>] [[-CertificateStore] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVmssVaultCertificateConfig** cmdlet specifies the secret that needs to be placed on the Virtual Machine Scale Set (VMSS) virtual machines. -The output of this cmdlet is intended to be used with the Add-AzureRmVmssSecret cmdlet. - -## EXAMPLES - -### Example 1: Create a Key Vault certificate configuration -``` -PS C:\> New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "MyCerts" -``` - -This command creates a Key Vault certificate configuration that uses the certificate store named MyCerts located at the specified certificate URL. - -## PARAMETERS - -### -CertificateStore -Specifies the certificate store on the virtual machines in the scale set where the certificate is added. -This is only valid for Windows Virtual Machine Scale Sets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateUrl -Specifies the URI of a certificate stored in the Key Vault. - -It is the base64 encoding of the following JSON Object which is encoded in UTF-8: - - -{ - "data":"\<Base64-encoded-certificate\>", - "dataType":"pfx", - "password":"\<pfx-file-password\>" -} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -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 -``` - -### -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssSecret](./Add-AzureRmVmssSecret.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Publish-AzureRmVMDscConfiguration.md b/azurermps-2.5.0/AzureRm.Compute/Publish-AzureRmVMDscConfiguration.md deleted file mode 100644 index 820398114a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Publish-AzureRmVMDscConfiguration.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: FB9ACBA2-081E-4876-A21A-F5BA11CBEDA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/publish-azurermvmdscconfiguration -schema: 2.0.0 ---- - -# Publish-AzureRmVMDscConfiguration - -## SYNOPSIS -Uploads a DSC script to Azure blob storage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UploadArchive (Default) -``` -Publish-AzureRmVMDscConfiguration [-ResourceGroupName] <String> [-ConfigurationPath] <String> - [[-ContainerName] <String>] [-StorageAccountName] <String> [-StorageEndpointSuffix <String>] [-Force] - [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateArchive -``` -Publish-AzureRmVMDscConfiguration [-ConfigurationPath] <String> [[-OutputArchivePath] <String>] [-Force] - [-SkipDependencyDetection] [-ConfigurationDataPath <String>] [-AdditionalPath <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Publish-AzureRmVMDscConfiguration** cmdlet uploads a Desired State Configuration (DSC) script to Azure blob storage, which later can be applied to Azure virtual machines using the Set-AzureRmVMDscExtension cmdlet. - -## EXAMPLES - -### Example 1: Create a .zip package an upload it to Azure storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1" -``` - -This command creates a .zip package for the given script and any dependent resource modules and uploads it to Azure storage. - -### Example 2: Create a .zip package and store it to a local file -``` -PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1" -OutputArchivePath ".\MyConfiguration.ps1.zip" -``` - -This command creates a .zip package for the given script and any dependent resource modules and stores it in the local file that is named .\MyConfiguration.ps1.zip. - -### Example 3: Add configuration to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -SkipDependencyDetection -``` - -This command adds configuration named Sample.ps1 to the configuration archive to upload to Azure storage and skips dependent resource modules. - -### Example 4: Add configuration and configuration data to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -ConfigurationDataPath "C:\SampleData.psd1" -``` - -This command adds configuration named Sample.ps1 and configuration data named SampleData.psd1 to the configuration archive to upload to Azure storage. - -### Example 5: Add configuration, configuration data, and additional content to the archive and then upload it to storage -``` -PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -AdditionalPath @("C:\ContentDir1", "C:\File.txt") -ConfigurationDataPath "C:\SampleData.psd1" -``` - -This command adds configuration named Sample.ps1, configuration data SampleData.psd1, and additional content to configuration archive to upload to Azure storage. - -## PARAMETERS - -### -AdditionalPath -Specifies the path of a file or a directory to include in the configuration archive. -It gets downloaded to the virtual machine together with the configuration. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationDataPath -Specifies the path of a .psd1 file that specifies the data for the configuration. -This is added to the configuration archive and then passed to the configuration function. -It gets overwritten by the configuration data path provided through the Set-AzureRmVMDscExtension cmdlet - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationPath -Specifies the path of a file that contains one or more configurations. -The file can be a Windows PowerShell script (.ps1) file or a Windows PowerShell module (.psm1) file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ContainerName -Specifies the name of the Azure storage container the configuration is uploaded to. - -```yaml -Type: String -Parameter Sets: UploadArchive -Aliases: - -Required: False -Position: 4 -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputArchivePath -Specifies the path of a local .zip file to write the configuration archive to. -When this parameter is used, the configuration script is not uploaded to Azure blob storage. - -```yaml -Type: String -Parameter Sets: CreateArchive -Aliases: ConfigurationArchivePath - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the storage account. - -```yaml -Type: String -Parameter Sets: UploadArchive -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipDependencyDetection -Indicates that this cmdlet excludes DSC resource dependencies from the configuration archive. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the Azure storage account name that is used to upload the configuration script to the container specified by the *ContainerName* parameter. - -```yaml -Type: String -Parameter Sets: UploadArchive -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpointSuffix -Specifies the suffix for the storage end point. - -```yaml -Type: String -Parameter Sets: UploadArchive -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -Parameter 'ConfigurationPath' accepts value of type 'String' from the pipeline - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRMVMSqlServerExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRMVMSqlServerExtension.md deleted file mode 100644 index 92f7d6eee4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B02CEAC8-C838-4890-8C21-9897CA39EF45 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmsqlserverextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMSqlServerExtension - -## SYNOPSIS -Removes a SQL Server extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMSqlServerExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMSqlServerExtension** cmdlet removes an AzureSQL Server extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a SQL Server extension -``` -PS C:\> Remove-AzureRMVMSqlServerExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" -Name "SqlIaaSAgent" -``` - -This command removes a SQL Server extension from the virtual machine named ContosoVM22. - -## 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 -Specifies the name of the SQL Server the extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet removes the SQL Server extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMSqlServerExtension](./Get-AzureRMVMSqlServerExtension.md) - -[Set-AzureRmVMSqlServerExtension](./Set-AzureRMVMSqlServerExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmAvailabilitySet.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmAvailabilitySet.md deleted file mode 100644 index ad0edeace8..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7320B832-50FD-48AE-9089-445318F3B08A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermavailabilityset -schema: 2.0.0 ---- - -# Remove-AzureRmAvailabilitySet - -## SYNOPSIS -Removes an availability set from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAvailabilitySet [-ResourceGroupName] <String> [[-Name] <String>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAvailabilitySet** cmdlet removes an availability set from Azure. - -## EXAMPLES - -### Example 1: Remove an availability set -``` -PS C:\> Remove-AzureRmAvailabilitySet -Name "AvailabilitySet03" -ResourceGroupName "ResourceGroup11" -``` - -This command removes an availability set named AvailablitySet03 in the resource group named ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The availability set name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, AvailabilitySetName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[New-AzureRmAvailabilitySet](./New-AzureRmAvailabilitySet.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerService.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerService.md deleted file mode 100644 index 374499552f..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerService.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8180092D-5B1D-43A0-B830-D009B30E2DDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermcontainerservice -schema: 2.0.0 ---- - -# Remove-AzureRmContainerService - -## SYNOPSIS -Removes a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmContainerService** cmdlet removes a container service from your Azure account. - -## EXAMPLES - -### Example 1: Remove a container service -``` -PS C:\> Remove-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command removes the container service named CSResourceGroup17. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the container service that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Update-AzureRmContainerService](./Update-AzureRmContainerService.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md deleted file mode 100644 index 97e8b7f700..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmContainerServiceAgentPoolProfile.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: ED37B17D-C513-422A-89EA-A6AF1C9A5FEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermcontainerserviceagentpoolprofile -schema: 2.0.0 ---- - -# Remove-AzureRmContainerServiceAgentPoolProfile - -## SYNOPSIS -Removes an agent pool profile from a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmContainerServiceAgentPoolProfile [-ContainerService] <PSContainerService> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmContainerServiceAgentPoolProfile** cmdlet removes an agent pool profile from a container service. - -## EXAMPLES - -### Example 1: Remove a profile from a container service -``` -PS C:\> $Container = Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -PS C:\> Remove-AzureRmContainerServiceAgentPoolProfile -ContainerService $Container -Name "AgentPool01" -``` - -The first command gets a container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. -The command stores the service in the $Container variable. - -The second command removes the profile named AgentPool01 from the container service in $Container. - -## PARAMETERS - -### -ContainerService -Specifies the container service object from which this cmdlet removes an agent pool profile. - -```yaml -Type: PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, 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 -``` - -### -Name -Specifies the name of the agent pool profile that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ContainerService -Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmDisk.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmDisk.md deleted file mode 100644 index ae5490c5ec..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmDisk.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermdisk -schema: 2.0.0 ---- - -# Remove-AzureRmDisk - -## SYNOPSIS -Removes a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDisk** cmdlet removes a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Force; -``` - -This command removes the disk named 'Disk01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImage.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImage.md deleted file mode 100644 index 0bb8dad870..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImage.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermimage -schema: 2.0.0 ---- - -# Remove-AzureRmImage - -## SYNOPSIS -Removes an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmImage** cmdlet removes an image.. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' -Force; -``` - -This command removes the image named 'Image01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImageDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImageDataDisk.md deleted file mode 100644 index 02892755ac..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmImageDataDisk.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermimagedatadisk -schema: 2.0.0 ---- - -# Remove-AzureRmImageDataDisk - -## SYNOPSIS -Removes a data disk from an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmImageDataDisk [-Image] <PSImage> [-Lun] <Int32> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmImageDataDisk** cmdlet removes a data disk from an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' | Remove-AzureRmImageDataDisk -Lun 1 | Update-AzureRmImage; -``` - -This command removes the data disk of logical unit number 1 from the existing image 'Image01' in the resource group 'ResourceGroup01'. - -## 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 -``` - -### -Image -Specifies a local image object. - -```yaml -Type: PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Image -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Image - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmSnapshot.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmSnapshot.md deleted file mode 100644 index 319f65da20..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmSnapshot.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermsnapshot -schema: 2.0.0 ---- - -# Remove-AzureRmSnapshot - -## SYNOPSIS -Removes a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmSnapshot** cmdlet removes a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Force; -``` - -This command removes the snapshot named 'Snapshot01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVM.md deleted file mode 100644 index 8c6d9b6932..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVM.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A16C2084-30A4-4AB8-AE22-28CC6E74FD48 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvm -schema: 2.0.0 ---- - -# Remove-AzureRmVM - -## SYNOPSIS -Removes a virtual machine from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Remove-AzureRmVM [-Name] <String> [-Force] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Remove-AzureRmVM [-Name] <String> [-Force] [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVM** cmdlet removes a virtual machine from Azure. - -## EXAMPLES - -### Example 1: Remove a virtual machine -``` -PS C:\> Remove-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command removes the virtual machine named VirtualMachine07 in the resource group ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName, VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAEMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAEMExtension.md deleted file mode 100644 index 4079fb3967..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B1CD5302-9BF0-460E-98FE-F60DFE072848 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmaemextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMAEMExtension - -## SYNOPSIS -Removes the AEM extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [[-OSType] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMAEMExtension** cmdlet removes the Azure Enhanced Monitoring (AEM) extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove the AEM extension -``` -PS C:\> Remove-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command removes the AEM extension for the virtual machine named contoso-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 -``` - -### -Name -Specifies the name of the virtual machine from which this cmdlet removes the AEM extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of a virtual machine. -This cmdlet removes the AEM extension from that virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet removes the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAccessExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAccessExtension.md deleted file mode 100644 index 72eb1732a2..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 22C490C2-0135-4375-897E-7224DBBE13A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmaccessextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMAccessExtension - -## SYNOPSIS -Removes the VMAccess extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMAccessExtension** cmdlet removes the Virtual Machine Access (VMAccess) Virtual Machine Extension from a virtual machine. - -## EXAMPLES - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet removes VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMAccessExtension](./Set-AzureRmVMAccessExtension.md) - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMBackup.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMBackup.md deleted file mode 100644 index 8d0c67b964..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMBackup.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 2AB1B227-68C4-49AE-84C0-E1421E609DE7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmbackup -schema: 2.0.0 ---- - -# Remove-AzureRmVMBackup - -## SYNOPSIS -Removes the backup from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMBackup [-ResourceGroupName] <String> [-VMName] <String> [-Tag] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMChefExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMChefExtension.md deleted file mode 100644 index e1970ad055..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMChefExtension.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 473C71A8-1DF7-487A-B239-B80E2BB63B82 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmchefextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMChefExtension - -## SYNOPSIS -Removes the Chef extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Remove-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Linux] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Windows -``` -Remove-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Windows] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureVMChefExtension** cmdlet removes the Chef extension from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a Chef extension from a Windows virtual machine -``` -PS C:\> Remove-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -Windows -``` - -This command removes a Chef extension from a Windows based virtual machine named WindowsVM001 that belongs to the resource group named ResourceGroup001. - -### Example 2: Remove a Chef extension from a Linux virtual machine -``` -PS C:\> Remove-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -Linux -``` - -This command removes a Chef extension from a Linux based virtual machine named LinuxVM001 that belongs to the resource group named ResourceGroup002. - -## 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 -``` - -### -Linux -Indicates that this cmdlet targets a Linux virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine for which this cmdlet removes the Chef extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet targets a Windows virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMChefExtension](./Get-AzureRmVMChefExtension.md) - -[Set-AzureRmVMChefExtension](./Set-AzureRmVMChefExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMCustomScriptExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index f9a6fe65ff..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A65E82D5-706B-4470-A51E-936E381DA78F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmcustomscriptextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Removes a custom script extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMCustomScriptExtension** cmdlet removes a custom script Virtual Machine Extension from a virtual machine. - -## EXAMPLES - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the custom script extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the custom script extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMCustomScriptExtension](./Get-AzureRmVMCustomScriptExtension.md) - -[Set-AzureRmVMCustomScriptExtension](./Set-AzureRmVMCustomScriptExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDataDisk.md deleted file mode 100644 index bfbfa0d039..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDataDisk.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D5943E9F-E4E6-4A1F-A144-44691CF32FC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdatadisk -schema: 2.0.0 ---- - -# Remove-AzureRmVMDataDisk - -## SYNOPSIS -Removes a data disk from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [[-DataDiskNames] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDataDisk** cmdlet removes a data disk from a virtual machine. - -## EXAMPLES - -### Example 1: Remove a data disk from a virtual machine -``` -PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -PS C:\> Remove-AzureRmVMDataDisk -VM $VirtualMachine -Name "Disk3" -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -The first command gets the virtual machine named VirtualMachine07 by using the **Get-AzureRmVM** cmdlet. -The command stores the virtual machine in the $VirtualMachine variable. - -The second command removes the data disk named Disk3 from the virtual machine stored in $VirtualMachine. - -The final command updates the state of the virtual machine stored in $VirtualMachine in ResourceGroup11. - -## PARAMETERS - -### -DataDiskNames -Specifies the names of one or more data disks that this cmdlet removes. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 1 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object from which to remove a data disk. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMDataDisk](./Add-AzureRmVMDataDisk.md) - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiagnosticsExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiagnosticsExtension.md deleted file mode 100644 index 9a4b7792e7..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiagnosticsExtension.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 89DA3965-5344-4A1D-AEF1-10EA58E129CF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdiagnosticsextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Removes the Diagnostics extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDiagnosticsExtension** cmdlet removes an Azure Diagnostics extension from a virtual machine. -You must pass the output of this cmdlet to the Update-AzureRmVM cmdlet to implement your changes. - -## EXAMPLES - -### Example 1: Remove the Diagnostics extension from a virtual machine -``` -PS C:\> Remove-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM22" | Update-AzureRmVM -``` - -This command removes the Diagnostics extension from a virtual machine named ContosoVM22. -The command passes the result to the Update-AzureRmVM cmdlet by using the pipeline operator. -That command updates the virtual machine. - -## 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 -Specifies the name of the Diagnostics extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which this cmdlet removes a Diagnostics extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiagnosticsExtension](./Get-AzureRMVMDiagnosticsExtension.md) - -[Set-AzureRmVMDiagnosticsExtension](./Set-AzureRMVMDiagnosticsExtension.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiskEncryptionExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiskEncryptionExtension.md deleted file mode 100644 index d46ea28d32..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDiskEncryptionExtension.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9DDB3672-4C98-4449-9F29-DD9501ED4D3E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdiskencryptionextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMDiskEncryptionExtension - -## SYNOPSIS -Removes the disk encryption extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDiskEncryptionExtension** cmdlet removes the disk encryption extension from a virtual machine. -If no extension name is specified, this cmdlet removes the extension with default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machines. -This cmdlet does not disable encryption on the virtual machine. -It removes the extension and the associated extension configuration from the virtual machine. - -## EXAMPLES - -### Example 1: Remove the disk encryption extension from a virtual machine. -``` -PS C:\> Remove-AzureRmVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" -``` - -This command removes the extension with default name AzureDiskEncryption for a virtual machine that runs the Windows operating system or AzureDiskEncryptionForLinux for Linux based virtual machine named MyTestVM. - -### Example 2: Remove a specific disk encryption extension from a virtual machine. -``` -PS C:\> Remove-AzureRmVMDiskEncryptionExtension -ResourceGroupName "MyResourceGroup" -VMName "MyTestVM" -Name "MyDiskEncryptionExtension" -``` - -This command removes the encryption extension named MyDiskEncryptionExtension from the virtual machine named MyTestVM. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The Set-AzureRmVMDiskEncryptionExtension cmdlet sets this name to AzureDiskEncryption for virtual machines that run the Windows operating system and AzureDiskEncryptionForLinux for Linux virtual machines. -Specify this parameter only if you changed the default name in the **Set-AzureRmVMDiskEncryptionExtension** cmdlet or used a different resource name in a Resource Manager template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Set-AzureRmVMDiskEncryptionExtension](./Set-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDscExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDscExtension.md deleted file mode 100644 index 9a27f22859..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMDscExtension.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C7FCF2CA-2C8D-4280-BF68-10DEA96642A5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmdscextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMDscExtension - -## SYNOPSIS -Removes a DSC extension handler from a virtual machine in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMDscExtension** cmdlet removes a Desired State Configuration (DSC) extension handler from a virtual machine in a resource group. - -## EXAMPLES - -### Example 1: Remove a DSC extension -``` -PS C:\> Remove-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -Name "DSC" -``` - -This command removes the extension named DSC on virtual machine named VM07. - -## 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 -Specifies the name of the DSC extension that this cmdlet removes. -The Set-AzureRmVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the default value used by **Remove-AzureRmVMDscExtension**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the DSC extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Set-AzureRmVMDscExtension](./Set-AzureRmVMDscExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMExtension.md deleted file mode 100644 index 8ef1c8192d..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMExtension.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6C40A7BA-6BE2-464A-84E4-9021935A5BF6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmextension -schema: 2.0.0 ---- - -# Remove-AzureRmVMExtension - -## SYNOPSIS -Removes an extension from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMExtension** cmdlet removes an extension from the Virtual Machine Extensions of a virtual machine. - -## EXAMPLES - -### Example 1: Remove an extension from a virtual machine -``` -PS C:\> Remove-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Name "ContosoTest" -VMName "VirtualMachine22" -``` - -This command removes the extension named ContosoTest from the virtual machine named VirtualMachine22 in 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 -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine from which this cmdlet removes the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMNetworkInterface.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMNetworkInterface.md deleted file mode 100644 index 791bee0a83..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMNetworkInterface.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6B26DADE-BF71-48D2-98C9-87B2F6182AC2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmnetworkinterface -schema: 2.0.0 ---- - -# Remove-AzureRmVMNetworkInterface - -## SYNOPSIS -Removes a network interface from a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMNetworkInterface [-VM] <PSVirtualMachine> [[-NetworkInterfaceIDs] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVMNetworkInterface** cmdlet removes a network interface from a virtual machine. - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -``` - -### -NetworkInterfaceIDs -Specifies an array of network interface IDs that this cmdlet removes. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Id, NicIds - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which this cmdlet removes a network interface. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMSecret.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMSecret.md deleted file mode 100644 index 340b773301..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVMSecret.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmsecret -schema: 2.0.0 ---- - -# Remove-AzureRmVMSecret - -## SYNOPSIS -Removes (a) secret(s) from a virtual machine object - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVMSecret [-VM] <PSVirtualMachine> [[-SourceVaultId] <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmVMSecret cmdlet removes (a) secret(s) from a virtual machine object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVM -ResourceGroupName "rg1" -Name "vm1" | Remove-AzureRmVMSecret | Update-AzureRmVM -``` - -Removes all secrets from a virtual machine "vm1" in resource group "rg1" and update the VM - -## 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 -``` - -### -SourceVaultId -Specifies an array of source vault IDs that this cmdlet removes. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Id - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which this cmdlet removes (a) secret(s). -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmss.md deleted file mode 100644 index 7753b2d84a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmss.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E6F2EE87-97C4-416A-9AE1-9FBD72062F0F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmss -schema: 2.0.0 ---- - -# Remove-AzureRmVmss - -## SYNOPSIS -Removes the VMSS or a virtual machine that is within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmss** cmdlet removes the Virtual Machine Scale Set (VMSS) from Azure. -This cmdlet can also be used to remove a specific virtual machine inside the VMSS. -You can use the *InstanceId* parameter to remove a specific virtual machine inside the VMSS. - -## EXAMPLES - -### Example 1: Remove a VMSS -``` -PS C:\> Remove-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMScaleSet001" -``` - -This command removes the VMSS named VMScaleSet001 that belongs to the resource group named Group001. - -### Example 2: Remove a virtual machine from within a VMSS -``` -PS C:\> Remove-AzureRmVmss -ResourceGroupName "Group002" -VMScaleSetName "VMScaleSet002" -InstanceId "3"; -``` - -This command removes the virtual machine with instance ID 3 from the VMSS named VMScaleSet002 that belongs to the resource group named Group002. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID of the instances that need to be started. -For instance: `-InstanceId "0", "3"` - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the VMSS belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS that this cmdlet removes. -If you specify the *InstanceId* parameter, the cmdlet will remove the specified virtual machine from the VMSS named by this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDataDisk.md deleted file mode 100644 index 20c1ee4517..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDataDisk.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssdatadisk -schema: 2.0.0 ---- - -# Remove-AzureRmVmssDataDisk - -## SYNOPSIS -Removes a data disk from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### LunParameterSet -``` -Remove-AzureRmVmssDataDisk [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Lun] <Int32> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssDataDisk** cmdlet removes a data disk from the Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -``` - -This command removes the data disk named 'DataDisk1' from the VMSS object. - -### Example 2 -``` -PS C:\> Remove-AzureRmVmssDataDisk -VirtualMachineScaleSet $vmss -Lun 0 -``` - -This command removes the data disk of LUN 0 from the VMSS object. - -## 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 -``` - -### -Lun -Specifies the logical unit number of the disk. - -```yaml -Type: Int32 -Parameter Sets: LunParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the disk. - -```yaml -Type: String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specify the VMSS object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet -System.String -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDiagnosticsExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDiagnosticsExtension.md deleted file mode 100644 index 16a3d58f67..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssDiagnosticsExtension.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 5F135E64-9432-4D08-961F-4604410378A3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssdiagnosticsextension -schema: 2.0.0 ---- - -# Remove-AzureRmVmssDiagnosticsExtension - -## SYNOPSIS -Removes a diagnostics extension from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVmssDiagnosticsExtension [-VirtualMachineScaleSet] <VirtualMachineScaleSet> [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssDiagnosticsExtension** cmdlet removes a diagnostics extension from the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Remove a diagnostics extension from the VMSS -``` -PS C:\> Remove-AzureRmVmssDiagnosticsExtension -VirtualMachineScaleSet $VMSS -Name $extName -``` - -This command removes diagnostics extension from the VMSS. - -## 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 -Specifies the name of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS from which to remove the extension. - -```yaml -Type: VirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssDiagnosticsExtension](./Add-AzureRmVmssDiagnosticsExtension.md) - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - -[Remove-AzureRmVmssExtension](./Remove-AzureRmVmssExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssExtension.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssExtension.md deleted file mode 100644 index 1f1589f119..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssExtension.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8C1C12AD-5130-42E7-99BB-B13900D7A712 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssextension -schema: 2.0.0 ---- - -# Remove-AzureRmVmssExtension - -## SYNOPSIS -Removes an extension from the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [-Id] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssExtension** cmdlet removes an extension from the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -## 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 -``` - -### -Id -Specifies the ID of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: String -Parameter Sets: IdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension that this cmdlet removes from the VMSS. - -```yaml -Type: String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS from which to remove the extension from. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssExtension](./Add-AzureRmVmssExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md b/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md deleted file mode 100644 index e322790540..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Remove-AzureRmVmssNetworkInterfaceConfiguration.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EC4E8CC1-C21F-4D41-818F-D0BC15AEEE1D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/remove-azurermvmssnetworkinterfaceconfiguration -schema: 2.0.0 ---- - -# Remove-AzureRmVmssNetworkInterfaceConfiguration - -## SYNOPSIS -Removes a network interface configuration from a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet -``` -Remove-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmVmssNetworkInterfaceConfiguration [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [-Id] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVmssNetworkInterfaceConfiguration** cmdlet removes a network interface configuration from a Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Remove an interface configuration -``` -PS C:\> $VMSS = Get-AzureRmVmss -ResourceGroupName "ResourceGroup11" -VMScaleSetName "ContosoVMSS14" -PS C:\> Remove-AzureRmVmssNetworkInterfaceConfiguration -VirtualMachineScaleSet $VMSS -Name "ContosoVmssInterface02" -``` - -The first command gets a VMSS by using the Get-AzureRmVmss cmdlet, and then stores it in the $VMSS variable. - -The second command removes the network interface configuration named ContosoVmssInterface02 from the set in $VMSS. - -## 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 -``` - -### -Id -Specifies the ID of the network interface configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: IdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVmssNetworkInterfaceConfiguration](./Add-AzureRmVmssNetworkInterfaceConfiguration.md) - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVM.md deleted file mode 100644 index afc37a80cb..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVM.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: EF155949-5766-4BC4-9C8A-2B97E8EA032D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/restart-azurermvm -schema: 2.0.0 ---- - -# Restart-AzureRmVM - -## SYNOPSIS -Restarts an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RestartResourceGroupNameParameterSetName (Default) -``` -Restart-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceResourceGroupNameParameterSetName -``` -Restart-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-PerformMaintenance] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RestartIdParameterSetName -``` -Restart-AzureRmVM [-Id] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### PerformMaintenanceIdParameterSetName -``` -Restart-AzureRmVM [-Id] <String> [-Name] <String> [-PerformMaintenance] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmVM** cmdlet restarts an Azure virtual machine. - -## EXAMPLES - -### Example 1: Restart a virtual machine -``` -PS C:\> Restart-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command restarts the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: String -Parameter Sets: RestartIdParameterSetName, PerformMaintenanceIdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PerformMaintenance -To perform the maintenance of virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: PerformMaintenanceResourceGroupNameParameterSetName, PerformMaintenanceIdParameterSetName -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: RestartResourceGroupNameParameterSetName, PerformMaintenanceResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVmss.md deleted file mode 100644 index 8134ee1cc9..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Restart-AzureRmVmss.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 47F0EE55-78C0-4C71-BD32-C7CB7B200DC3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/restart-azurermvmss -schema: 2.0.0 ---- - -# Restart-AzureRmVmss - -## SYNOPSIS -Restarts the VMSS or a virtual machine within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restart-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmVmss** cmdlet restarts the Virtual Machine Scale Set (VMSS). -This cmdlet can also be used to restart a specific virtual machine inside the VMSS by using the *InstanceId* parameter. - -## EXAMPLES - -### Example 1: Restart the VMSS -``` -PS C:\> Restart-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001"; -``` - -This command restarts the VMSS named VMSS001 that belongs to the resource group named Group001. - -### Example 2: Restart a specific virtual machine within the VMSS -``` -PS C:\> Restart-AzureRmVmss -ResourceGroupName "Group004" -VMScaleSetName "VMSS001" -InstanceId "1" -``` - -This command restarts a virtual machine that has the instance ID of 1 in the VMSS named VMSS001 that belongs to the resource group named Group001. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID of the instances that need restarted. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS that this cmdlet restarts. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmDiskAccess.md b/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmDiskAccess.md deleted file mode 100644 index c9a3d44c25..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmDiskAccess.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/revoke-azurermdiskaccess -schema: 2.0.0 ---- - -# Revoke-AzureRmDiskAccess - -## SYNOPSIS -Revokes an access to a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmDiskAccess [-ResourceGroupName] <String> [-DiskName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmDiskAccess** cmdlet revokes an access to a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Revoke-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -``` - -Revoke the access to the disk named 'Disk01' in the resource group named 'ResourceGroup01' - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmSnapshotAccess.md b/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmSnapshotAccess.md deleted file mode 100644 index b508709584..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Revoke-AzureRmSnapshotAccess.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/revoke-azurermsnapshotaccess -schema: 2.0.0 ---- - -# Revoke-AzureRmSnapshotAccess - -## SYNOPSIS -Revokes an access to a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Revoke-AzureRmSnapshotAccess [-ResourceGroupName] <String> [-SnapshotName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Revoke-AzureRmSnapshotAccess** cmdlet revokes an access to a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Revoke-AzureRmDiskAccess -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -``` - -Revoke the access to the snapshot named 'Snapshot01' in the resource group named 'ResourceGroup01' - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVMImage.md b/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVMImage.md deleted file mode 100644 index 2bf22b80c5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVMImage.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D2B5BC27-6D51-45BC-AE6A-F7FED11B8651 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/save-azurermvmimage -schema: 2.0.0 ---- - -# Save-AzureRmVMImage - -## SYNOPSIS -Saves a virtual machine as a VMImage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Save-AzureRmVMImage [-Name] <String> [-DestinationContainerName] <String> [-VHDNamePrefix] <String> - [-Overwrite] [[-Path] <String>] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Save-AzureRmVMImage [-Name] <String> [-DestinationContainerName] <String> [-VHDNamePrefix] <String> - [-Overwrite] [[-Path] <String>] [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmVMImage** cmdlet saves a virtual machine as a VMImage. -Before you create a virtual machine image, sysprep the virtual machine, and then mark it as generalized by using the Set-AzureRmVM cmdlet. - -The output of this cmdlet is a JavaScript Object Notation (JSON) template. -You can deploy virtual machines from your captured image. - -## EXAMPLES - -### Example 1: Capture a virtual machine -``` -PS C:\> Set-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized -PS C:\> Save-AzureRmVMImage -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -DestinationContainerName "VMContainer01" -VHDNamePrefix "VM07" -``` - -The first command marks the virtual machine named VirtualMachine07 as generalized. - -The second command captures a virtual machine named VirtualMachine07 as a VMImage. -The **Output** property returns a JSON template. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationContainerName -Specifies the name of a container inside the "system" container that you want to hold your images. - -If the container doesn't exist, it is created for you. -The virtual hard disks (VHDs) that constitute the VMImage reside in the container that this parameter specifies. -If the VHDs are spread across multiple storage accounts, this cmdlet creates one container that has this name in each storage account. -The URL of the saved image is similar to: - -https://\<storageAccountName\>.blob.core.windows.net/system/Microsoft.Compute/Images/\<imagesContainer\>/\<vhdPrefix-osDisk\>.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.vhd. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Indicates that this cmdlet overwrites any VHDs that have the same prefix in the destination container. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the VHD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VHDNamePrefix -Specifies the prefix in the name of the blobs that constitute the storage profile of the VMImage. - -For example, a prefix vhdPrefix for an operating system disk results in the name vhdPrefix-osdisk.\<guid\>.vhd. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: VirtualHardDiskNamePrefix - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[Set-AzureRmVM](./Set-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVhd.md b/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVhd.md deleted file mode 100644 index 9da11514c2..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Save-AzureRmVhd.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 18E1AD70-42A6-47A2-A685-6E218B6DC4BE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/save-azurermvhd -schema: 2.0.0 ---- - -# Save-AzureRmVhd - -## SYNOPSIS -Saves downloaded .vhd images locally. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSetName -``` -Save-AzureRmVhd [-ResourceGroupName] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> - [[-NumberOfThreads] <Int32>] [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### StorageKeyParameterSetName -``` -Save-AzureRmVhd [-StorageKey] <String> [-SourceUri] <Uri> [-LocalFilePath] <FileInfo> - [[-NumberOfThreads] <Int32>] [-OverWrite] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmVhd** cmdlet saves .vhd images from a blob where they are stored to a file. -You can specify the number of downloader threads that the process uses and whether to replace a file that already exists. - -This cmdlet downloads content as it is. -It does not apply any Virtual Hard Disk (VHD) format conversion. - -## EXAMPLES - -### Example 1: Download an image -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path C:\vhd\Win7Image.vhd. - -### Example 2: Download an image and overwrite the local file -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path. -The command includes the *Overwrite* parameter. -Therefore, if C:\vhd\Win7Image.vhd already exists, this command replaces it. - -### Example 3: Download an image by using a specified number of threads -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfThreads 32 -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file, and stores it in the local path. -The command specifies a value of 32 for the *NumberOfThreads* parameter. -Therefore, the cmdlet uses 32 threads for this action. - -### Example 4: Download an image and specify the storage key -``` -PS C:\> Save-AzureRmVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -StorageKey "zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw==" -ResourceGroupName "rgname" -``` - -This command downloads a .vhd file and specifies the storage key. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalFilePath -Specifies the local file path of the saved image. - -```yaml -Type: FileInfo -Parameter Sets: (All) -Aliases: lf - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfThreads -Specifies the number of download threads that this cmdlet uses during download. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: th - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverWrite -Indicates that this cmdlet replaces the file specified by *LocalFilePath* file if it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: o - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the storage account. - -```yaml -Type: String -Parameter Sets: ResourceGroupParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceUri -Specifies the Uniform Resource Identifier (URI) of the blob in `Azure`. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: src, Source - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageKey -Specifies the storage key of the blob storage account. -If you do not specify a key, this cmdlet attempts to determine the storage key of the account in *SourceUri* from Azure. - -```yaml -Type: String -Parameter Sets: StorageKeyParameterSetName -Aliases: sk - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.VhdDownloadContext - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVhd](./Add-AzureRMVhd.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDataDisk.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDataDisk.md deleted file mode 100644 index 48abbf14e8..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDataDisk.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C453485D-67A7-480E-83F6-527D4F5EBC93 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdatadisk -schema: 2.0.0 ---- - -# Set-AzureRmVMDataDisk - -## SYNOPSIS -Modifies properties of a virtual machine data disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ChangeWithName -``` -Set-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [-Name] <String> [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-StorageAccountType <StorageAccountTypes>] [-WriteAccelerator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ChangeWithLun -``` -Set-AzureRmVMDataDisk [-VM] <PSVirtualMachine> [-Lun] <Int32> [[-Caching] <CachingTypes>] - [[-DiskSizeInGB] <Int32>] [-StorageAccountType <StorageAccountTypes>] [-WriteAccelerator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDataDisk** cmdlet modifies properties of a virtual machine data disk. - -## EXAMPLES - -### Example 1: Modify the caching mode of a data disk -``` -PS C:\> $VM = Get-AzureRMVM -ResourceGroupName "ResourceGroup11" -VMName "ContosoVM07" -PS C:\> Set-AzureRmVMDataDisk -VM $VM -Name "DataDisk01" -Caching ReadWrite | Update-AzureRmVM -``` - -The first command gets the virtual machine named ContosoVM07 by using **Get-AzureRmVM**. -The command stores it in the $VM variable. - -The second command modifies the caching mode for the data disk named DataDisk01 on the virtual machine in $VM. -The command passes the result to the Update-AzureRmVM cmdlet, which implements your changes. -A change to the cashing mode causes the virtual machine to restart. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the disk. -The acceptable values for this parameter are: - -- ReadOnly -- ReadWrite - -The default value is ReadWrite. -Changing this value causes the virtual machine to restart. - -This setting affects the consistency and performance of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 2 -Default value: None -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 -``` - -### -DiskSizeInGB -Specifies the size, in gigabytes, for the data disk. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) of the data disk that this cmdlet modifies. - -```yaml -Type: Int32 -Parameter Sets: ChangeWithLun -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the data disk that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: ChangeWithName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The virtual machine managed disk's account type. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which this cmdlet modifies a data disk. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the data disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDiagnosticsExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDiagnosticsExtension.md deleted file mode 100644 index 6230211ef5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMDiagnosticsExtension.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 13ED884A-6224-4BD4-9F12-F896932F7842 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdiagnosticsextension -schema: 2.0.0 ---- - -# Set-AzureRmVMDiagnosticsExtension - -## SYNOPSIS -Configures the Azure diagnostics extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMDiagnosticsExtension [-ResourceGroupName] <String> [-VMName] <String> - [-DiagnosticsConfigurationPath] <String> [[-StorageAccountName] <String>] [[-StorageAccountKey] <String>] - [[-StorageAccountEndpoint] <String>] [[-StorageContext] <IStorageContext>] [[-Location] <String>] - [[-Name] <String>] [[-TypeHandlerVersion] <String>] [[-AutoUpgradeMinorVersion] <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDiagnosticsExtension** cmdlet configures the Azure diagnostics extension on a virtual machine. - -## EXAMPLES - -### Example 1: Enable diagnostics using a storage account specified in a diagnostics configuration file -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -``` - -This command uses a diagnostics configuration file to enable diagnostics. -The file diagnostics_publicconfig.xml contains the public XML configuration for the diagnostics extension including the name of the storage account to which diagnostics data will be sent. -The diagnostics storage account must be in the same subscription as the virtual machine. - -### Example 2: Enable diagnostics using a storage account name -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup1" -VMName "VirtualMachine2" -DiagnosticsConfigurationPath diagnostics_publicconfig.xml -StorageAccountName "MyStorageAccount" -``` - -This command uses the storage account name to enable diagnostics. -If the diagnostics configuration does not specify a storage account name or if you want to override the diagnostics storage account name specified in the configuration file, use the *StorageAccountName* parameter. -The diagnostics storage account must be in the same subscription as the virtual machine. - -### Example 3: Enable diagnostics using storage account name and key -``` -PS C:\> Set-AzureRmVMDiagnosticsExtension -ResourceGroupName "ResourceGroup01" -VMName "VirtualMachine02" -DiagnosticsConfigurationPath "diagnostics_publicconfig.xml" -StorageAccountName "MyStorageAccount" -StorageAccountKey $storage_key -``` - -This command uses the storage account name and key to enable diagnostics. -If the diagnostics storage account is in a different subscription than the virtual machine then enable sending diagnostics data to that storage account by explicitly specifying its name and key. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -Indicates whether this cmdlet allows the Azure guest agent to automatically update the extension to a newer minor version. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -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 -``` - -### -DiagnosticsConfigurationPath -Specifies the path of the configuration file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountEndpoint -Specifies the storage account endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the storage account key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageContext -Specifies the Azure storage context. - -```yaml -Type: IStorageContext -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which this cmdlet operates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDiagnosticsExtension](./Get-AzureRMVMDiagnosticsExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - -[Remove-AzureRmVMDiagnosticsExtension](./Remove-AzureRmVMDiagnosticsExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMSqlServerExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMSqlServerExtension.md deleted file mode 100644 index adc3b2b4be..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRMVMSqlServerExtension.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: C650E465-7CDE-47F8-B85A-8FA3E1756FAF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmsqlserverextension -schema: 2.0.0 ---- - -# Set-AzureRmVMSqlServerExtension - -## SYNOPSIS -Sets the Azure SQL Server extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMSqlServerExtension [[-Version] <String>] [-ResourceGroupName] <String> [-VMName] <String> - [[-Name] <String>] [[-AutoPatchingSettings] <AutoPatchingSettings>] - [[-AutoBackupSettings] <AutoBackupSettings>] [[-KeyVaultCredentialSettings] <KeyVaultCredentialSettings>] - [[-Location] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMSqlServerExtension** cmdlet sets the AzureSQL Server extension on a virtual machine. - -## EXAMPLES - -### Example 1: Set automatic patching settings on a virtual machine -``` -PS C:\> $AutoPatchingConfig = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" -PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoPatchingSettings $AutoPatchingConfig | Update-AzureRmVM -``` - -The first command creates a configuration object by using the **New-AzureVMSqlServerAutoPatchingConfig** cmdlet. -The command stores the configuration in the $AutoPatchingConfig variable. - -The second command gets the virtual machine named VirtualMachine11 on the service named Service02 by using the Get-AzureRmVM cmdlet. -The command passes that object to the current cmdlet by using the pipeline operator. - -The current cmdlet sets the automatic patching settings in $AutoPatchingConfig for the virtual machine. -The command passes the virtual machine to the Update-AzureRmVM cmdlet. - -### Example 2: Set automatic backup settings on a virtual machine -``` -PS C:\> $AutoBackupConfig = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $StorageUrl -StorageKey $StorageAccountKeySecure -PS C:\> Get-AzureRmVM -ServiceName "Service02" -Name "VirtualMachine11" | Set-AzureRmVMSqlServerExtension -AutoBackupSettings $AutoBackupConfig | Update-AzureRmVM -``` - -The first command creates a configuration object by using the **New-AzureVMSqlServerAutoBackupConfig** cmdlet. -The command stores the configuration in the $AutoBackupConfig variable. - -The second command gets the virtual machine named VirtualMachine11 on the service named Service02, and then passes it to the current cmdlet. - -The current cmdlet sets the automatic backup settings in $AutoBackupConfig for the virtual machine. -The command passes the virtual machine to the Update-AzureRmVM cmdlet. - -### Example 3: Disable a SQL Server extension on a virtual machine -``` -PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Disable -``` - -This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. -The command disables SQL Server virtual machine extension on that virtual machine. - -### Example 4: Uninstall a SQL Server extension on a specific virtual machine -``` -PS C:\> Get-AzureRmVM -ServiceName "Service03" -Name "VirtualMachine08" | Set-AzureRmVMSqlServerExtension -Uninstall -``` - -This command gets a virtual machine named VirtualMachine08 on Service03, and then passes it to the current cmdlet. -The command uninstalls a SQL Server virtual machine extension on that virtual machine. - -## PARAMETERS - -### -AutoBackupSettings -Specifies the automatic SQL Server backup settings. -To create an **AutoBackupSettings** object , use the New-AzureVMSqlServerAutoBackupConfig cmdlet. - -```yaml -Type: AutoBackupSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoPatchingSettings -Specifies the automatic SQL Server patching settings. -To create an **AutoPatchingSettings** object , use the New-AzureVMSqlServerAutoPatchingConfig cmdlet. - -```yaml -Type: AutoPatchingSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -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 -``` - -### -KeyVaultCredentialSettings -```yaml -Type: KeyVaultCredentialSettings -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the SQL Server the extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the SQL Server extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which this cmdlet sets the SQL Server extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMSqlServerExtension](./Get-AzureRMVMSqlServerExtension.md) - - - - - -[Remove-AzureRmVMSqlServerExtension](./Remove-AzureRMVMSqlServerExtension.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskDiskEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskDiskEncryptionKey.md deleted file mode 100644 index 6ae5525758..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskDiskEncryptionKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskdiskencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmDiskDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskDiskEncryptionKey [-Disk] <PSDisk> [[-SecretUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskImageReference.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskImageReference.md deleted file mode 100644 index 79f7947f46..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskImageReference.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskimagereference -schema: 2.0.0 ---- - -# Set-AzureRmDiskImageReference - -## SYNOPSIS -Sets the image reference properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskImageReference [-Disk] <PSDisk> [[-Id] <String>] [[-Lun] <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskImageReference** cmdlet sets the image reference properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; -PS C:\> $image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; -PS C:\> $diskconfig = Set-AzureRmDiskImageReference -Disk $diskconfig -Id $image -Lun 0; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local disk object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. -The second command sets the image id and the logical unit number 0 for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Id -Specifies the ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk -System.String -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskKeyEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskKeyEncryptionKey.md deleted file mode 100644 index c4216e7bc3..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskKeyEncryptionKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskkeyencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmDiskKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a disk object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskKeyEncryptionKey [-Disk] <PSDisk> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskconfig = New-AzureRmDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskconfig = Set-AzureRmDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskconfig = Set-AzureRmDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig; -``` - -The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk object. -The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: PSDisk -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Disk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md deleted file mode 100644 index a28ac2e4fe..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateDiskEncryptionKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskupdatediskencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmDiskUpdateDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskUpdateDiskEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: PSDiskUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.DiskUpdate -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.DiskUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md deleted file mode 100644 index 2ede8668c1..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmDiskUpdateKeyEncryptionKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermdiskupdatekeyencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmDiskUpdateKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a disk update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDiskUpdateKeyEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-KeyUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiskUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a disk update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: PSDiskUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.DiskUpdate -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.DiskUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmImageOsDisk.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmImageOsDisk.md deleted file mode 100644 index ac278b21d7..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmImageOsDisk.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermimageosdisk -schema: 2.0.0 ---- - -# Set-AzureRmImageOsDisk - -## SYNOPSIS -Sets the operating system disk properties on an image object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmImageOsDisk [-Image] <PSImage> [[-OsType] <OperatingSystemTypes>] - [[-OsState] <OperatingSystemStateTypes>] [[-BlobUri] <String>] [-Caching <CachingTypes>] [-DiskSizeGB <Int32>] - [-StorageAccountType <StorageAccountTypes>] [-SnapshotId <String>] [-ManagedDiskId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmImageOsDisk** cmdlet sets the operating system disk properties on an image object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $imageConfig = New-AzureRmImageConfig -Location 'West US'; -PS C:\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd" -PS C:\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd" -PS C:\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd" -PS C:\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1; -PS C:\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2; -PS C:\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01'; -``` - -The first command creates an image object, and then stores it in the $imageConfig variable. - -The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. -This approach is only for readability of the following commands. - -The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. -The URI of each disk is stored in $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2. - -The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'. - -## PARAMETERS - -### -BlobUri -Specifies the Uri of the blob. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Caching -Specifies the caching mode of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeGB -Specifies the size of the disk in GB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsState -Specifies the OS state. - -```yaml -Type: OperatingSystemStateTypes -Parameter Sets: (All) -Aliases: -Accepted values: Generalized, Specialized - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the ID of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountType -The Storage Account type of Os Image Disk - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Image -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.String -System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Image - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md deleted file mode 100644 index bf548e3294..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotDiskEncryptionKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotdiskencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmSnapshotDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotDiskEncryptionKey [-Snapshot] <PSSnapshot> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -SecretUrl -Specifies the secret Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotImageReference.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotImageReference.md deleted file mode 100644 index 7806fad57d..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotImageReference.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotimagereference -schema: 2.0.0 ---- - -# Set-AzureRmSnapshotImageReference - -## SYNOPSIS -Sets the image reference properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotImageReference [-Snapshot] <PSSnapshot> [[-Id] <String>] [[-Lun] <Int32>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotImageReference** cmdlet sets the image reference properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -SnapshotSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption FromImage; -PS C:\> $image = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Compute/images/TestImage123'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotImageReference -Snapshot $snapshotconfig -Id $image -Lun 0; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local snapshot object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. -The second command sets the image ID and the logical unit number 0 for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -Id -Specifies the ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot -System.String -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md deleted file mode 100644 index c6bc4961a4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotKeyEncryptionKey.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotkeyencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmSnapshotKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a snapshot object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotKeyEncryptionKey [-Snapshot] <PSSnapshot> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig; -``` - -The first command creates a local empty snapshot object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot object. -The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: PSSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.Snapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md deleted file mode 100644 index 50d5b1c2a1..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateDiskEncryptionKey.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotupdatediskencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmSnapshotUpdateDiskEncryptionKey - -## SYNOPSIS -Sets the disk encryption key properties on a snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotUpdateDiskEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-SecretUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotUpdateDiskEncryptionKey** cmdlet sets the disk encryption key properties on a snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -SecretUrl -Specifes the secret Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: PSSnapshotUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.SnapshotUpdate -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.SnapshotUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md deleted file mode 100644 index df3d8f6ea5..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmSnapshotUpdateKeyEncryptionKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermsnapshotupdatekeyencryptionkey -schema: 2.0.0 ---- - -# Set-AzureRmSnapshotUpdateKeyEncryptionKey - -## SYNOPSIS -Sets the key encryption key properties on a snapshot update object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmSnapshotUpdateKeyEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-KeyUrl] <String>] - [[-SourceVaultId] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmSnapshotUpdateKeyEncryptionKey** cmdlet sets the key encryption key properties on a snapshot update object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -## 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 -``` - -### -KeyUrl -Specifes the key Url. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: PSSnapshotUpdate -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SourceVaultId -Specifies the source vault ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.SnapshotUpdate -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.SnapshotUpdate - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVM.md deleted file mode 100644 index b0b3ea04b4..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVM.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 939320CB-2595-4150-AFDD-500CEA78559C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvm -schema: 2.0.0 ---- - -# Set-AzureRmVM - -## SYNOPSIS -Marks a virtual machine as generalized. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GeneralizeResourceGroupNameParameterSetName (Default) -``` -Set-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Generalized] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RedeployResourceGroupNameParameterSetName -``` -Set-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-Redeploy] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GeneralizeIdParameterSetName -``` -Set-AzureRmVM [-Id] <String> [-Name] <String> [-Generalized] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RedeployIdParameterSetName -``` -Set-AzureRmVM [-Id] <String> [-Name] <String> [-Redeploy] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVM** cmdlet marks a virtual machine as generalized. -Before you run this cmdlet, log on to the virtual machine and use Sysprep to prepare the hard disk. - -## EXAMPLES - -### Example 1: Mark a virtual machine as generalized -``` -PS C:\> Set-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized -``` - -This command marks the virtual machine named VirtualMachine07 as generalized. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Generalized -Indicates that this cmdlet marks a virtual machine as generalized. - -```yaml -Type: SwitchParameter -Parameter Sets: GeneralizeResourceGroupNameParameterSetName, GeneralizeIdParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Resource ID of the virtual machine. - -```yaml -Type: String -Parameter Sets: GeneralizeIdParameterSetName, RedeployIdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine on which this cmdlet operates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Redeploy -Indicates that this cmdlet manually redeploys the virtual machine to a different Azure host to fix any problems. - -If you redeploy a virtual machine, it restarts, which results in the loss of ephemeral drive data. - -```yaml -Type: SwitchParameter -Parameter Sets: RedeployResourceGroupNameParameterSetName, RedeployIdParameterSetName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: GeneralizeResourceGroupNameParameterSetName, RedeployResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMADDomainExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMADDomainExtension.md deleted file mode 100644 index a78506623b..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMADDomainExtension.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 65BF37D3-4FCE-48A3-BC5D-01AA20FEB6CA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaddomainextension -schema: 2.0.0 ---- - -# Set-AzureRmVMADDomainExtension - -## SYNOPSIS -Adds an AD domain extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMADDomainExtension -DomainName <String> [-OUPath <String>] [-JoinOption <UInt32>] - [-Credential <PSCredential>] [-Restart] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMADDomainExtension** cmdlet adds an Azure Active Directory (AD) domain virtual machine extension to a virtual machine. -This extension lets your virtual machine join a domain. - -## EXAMPLES - -## PARAMETERS - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: PSCredential -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DomainName -Specifies the name of the domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. - -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -JoinOption -Specifies the join option. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```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 domain extension to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OUPath -Specifies an organizational unit (OU) for the domain account. -Enter the full distinguished name of the OU in quotation marks. -The default value is the default OU for machine objects in the domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Restart -Indicates that this cmdlet restarts the virtual machine. -A restart is often required to make the change effective. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the domain extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMADDomainExtension](./Get-AzureRmVMADDomainExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAEMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAEMExtension.md deleted file mode 100644 index d466cdc554..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3B15C734-DF57-433A-8854-ACE2B35FF6CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaemextension -schema: 2.0.0 ---- - -# Set-AzureRmVMAEMExtension - -## SYNOPSIS -Enables support for monitoring for SAP systems. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [-DisableWAD] [-EnableWAD] - [[-WADStorageAccountName] <String>] [[-OSType] <String>] [-SkipStorage] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMAEMExtension** cmdlet updates the configuration of a virtual machine to enable or update the support for monitoring for SAP systems that are installed on the virtual machine. -The cmdlet installs the Azure Enhanced Monitoring (AEM) extension that collects the performance data and makes it discoverable for the SAP system. - -## EXAMPLES - -### Example 1: Use AEM extension -``` -PS C:\> Set-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -WADStorageAccountName "stdstorage" -``` - -This command configures the virtual machine named contoso-server to use the AEM extension. -The command specifies the storage account named stdstorage. - -## 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 -``` - -### -DisableWAD -Indicates that this cmdlet does not enable Azure Diagnostics for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWAD -If this parameter is provided, the commandlet will enable Windows Azure Diagnostics for this virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipStorage -Indicates that this cmdlet skips configuration of storage. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WADStorageAccountName -Specifies the name of the storage account that this cmdlet uses to configure the LinuxDiagnostics or IaaSDiagnostics extension. -If the virtual machine does not use a standard storage account, you must specify a value for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Test-AzureRmVMAEMExtension](./Test-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAccessExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAccessExtension.md deleted file mode 100644 index 3fe48b3d4a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMAccessExtension.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: D93666EC-C252-4E3B-B311-50B6EEA6D4BF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmaccessextension -schema: 2.0.0 ---- - -# Set-AzureRmVMAccessExtension - -## SYNOPSIS -Adds the VMAccess extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMAccessExtension [-Credential <PSCredential>] [-ResourceGroupName] <String> [-VMName] <String> - [-Name <String>] [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] - [-ForceRerun <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMAccessExtension** cmdlet adds the Virtual Machine Access (VMAccess) Virtual Machine VMAccess Extension to a virtual machine. VMAccess Extension can be used to set a temporary password and this should be immediately changed it after logging into the machine. - -## EXAMPLES - -### Example 1: Add a VMAccess extension -``` -PS C:\> Set-AzureRmVMAccessExtension -ResourceGroupName "ResrouceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.0" -UserName "PFuller" -Password "Password" -``` - -This command adds a VMAccess extension for the virtual machine named VirtualMachine07 in ResrouceGroup11. -The command specifies the name and type handler version for VMAccess. - -## PARAMETERS - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: PSCredential -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. - -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```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 extension that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds VMAccess for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAccessExtension](./Get-AzureRmVMAccessExtension.md) - -[Remove-AzureRmVMAccessExtension](./Remove-AzureRmVMAccessExtension.md) - -[Set-AzureRmVMExtension](./Set-AzureRmVMExtension.md) - -[Get-AzureRmVMExtensionImage](./Get-AzureRmVMExtensionImage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBackupExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBackupExtension.md deleted file mode 100644 index 2a5f9ee48a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBackupExtension.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CBFFBF1B-1AF0-4D2F-9315-C3790A4E9346 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbackupextension -schema: 2.0.0 ---- - -# Set-AzureRmVMBackupExtension - -## SYNOPSIS -Sets the backup extension properties on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMBackupExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Tag] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBginfoExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBginfoExtension.md deleted file mode 100644 index 13aa5898fb..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBginfoExtension.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: B2B4E132-4A71-4DB8-A7B9-9ED3FE7EB292 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbginfoextension -schema: 2.0.0 ---- - -# Set-AzureRmVMBginfoExtension - -## SYNOPSIS -Adds the BGInfo extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMBginfoExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMBGInfoExtension** cmdlet adds the BGInfo extension to a virtual machine. - -## EXAMPLES - -### Example 1: Add the BGInfo extension for a virtual machine -``` -PS C:\> Set-AzureVMBGInfoExtension -ResrouceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location "West Europe" -``` - -This command adds the BGInfo extension to virtual machine named ContosoVM. -The command specifies the resource group and location of the virtual machine. -The command specifies the name and version of the extension. - -## 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 -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extension to a newer minor version. -By default, this cmdlet enables the guest agent to update the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Specifies that the extension should be run again with the same public or protected settings. -The value can be any string different from the current value. - -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```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 BGInfo extension that this cmdlet adds to a virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine to which this cmdlet adds an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension that this cmdlet adds to the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which this cmdlet adds the BGInfo extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBootDiagnostics.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBootDiagnostics.md deleted file mode 100644 index 881a29455a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMBootDiagnostics.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9A6F140C-9F1C-4701-9603-FC6107FCAF92 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmbootdiagnostics -schema: 2.0.0 ---- - -# Set-AzureRmVMBootDiagnostics - -## SYNOPSIS -Modifies boot diagnostics properties of a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnableBootDiagnostics -``` -Set-AzureRmVMBootDiagnostics [-VM] <PSVirtualMachine> [-Enable] [-ResourceGroupName] <String> - [[-StorageAccountName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### DisableBootDiagnostics -``` -Set-AzureRmVMBootDiagnostics [-VM] <PSVirtualMachine> [-Disable] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMBootDiagnostics** cmdlet modifies boot diagnostics properties of a virtual machine. - -## EXAMPLES - -### Example 1: Enable boot diagnostics -``` -PS C:\> $VM = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "ContosoVM07" -PS C:\> Set-AzureRmVMBootDiagnostics -VM $VM -Enable -ResourceGroupName "ResourceGroup11" -StorageAccountName "DiagnosticStorage" -``` - -The first command gets the virtual machine named ContosoVM07 by using **Get-AzureRmVM**. -The command stores it in the $VM variable. - -The second command enables boot diagnostics for the virtual machine in $VM. -Diagnostics data is stored in the specified account. - -## 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 -``` - -### -Disable -Indicates that this cmdlet disables the boot diagnostics for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: DisableBootDiagnostics -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates that this cmdlet enables the boot diagnostics for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the storage account in which to save boot diagnostics data. - -```yaml -Type: String -Parameter Sets: EnableBootDiagnostics -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which this cmdlet changes boot diagnostics. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMBootDiagnosticsData](./Get-AzureRmVMBootDiagnosticsData.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMChefExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMChefExtension.md deleted file mode 100644 index 24877c6330..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMChefExtension.md +++ /dev/null @@ -1,454 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: CC306D8C-A5EE-4655-B686-E5A77CCE5042 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmchefextension -schema: 2.0.0 ---- - -# Set-AzureRmVMChefExtension - -## SYNOPSIS -Adds a Chef extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Linux -``` -Set-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] - -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] - [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] - [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] - [-BootstrapVersion <String>] [-Linux] [[-Location] <String>] [[-Name] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Windows -``` -Set-AzureRmVMChefExtension [-ResourceGroupName] <String> [-VMName] <String> [[-TypeHandlerVersion] <String>] - -ValidationPem <String> [-ClientRb <String>] [-BootstrapOptions <String>] [-JsonAttribute <String>] - [-ChefDaemonInterval <String>] [-Daemon <String>] [-Secret <String>] [-SecretFile <String>] - [-RunList <String>] [-ChefServerUrl <String>] [-ValidationClientName <String>] [-OrganizationName <String>] - [-BootstrapVersion <String>] [-Windows] [[-Location] <String>] [[-Name] <String>] - [[-AutoUpgradeMinorVersion] <Boolean>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureVMChefExtension** cmdlet adds the Chef extension to the virtual machine. - -## EXAMPLES - -### Example 1: Add a Chef extension to a Windows virtual machine -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup001" -VMName "WindowsVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Daemon "service" -SecretFile "C:\my_encrypted_data_bag_secret" -Windows -``` - -This command adds a Chef extension to a Windows virtual machine named WindowsVM001. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. - -### Example 2: Add a Chef extension to a Linux virtual machine -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup002" -VMName "LinuxVM001" -ValidationPem "C:\my-org-validator.pem" -ClientRb "C:\client.rb" -RunList "Apache" -Secret "my_secret" -Linux -``` - -This command adds a Chef extension to a Linux virtual machine named LinuxVM001. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. - -### Example 3: Add a Chef extension to a Windows virtual machine with bootstrap options -``` -PS C:\> Set-AzureRmVMChefExtension -ResourceGroupName "ResourceGroup003" -VMName "WindowsVM002" -ValidationPem C:\my-org-validator.pem -ClientRb C:\client.rb -BootstrapOptions '{"chef_node_name":"your_node_name","chef_server_url":"https://api.opscode.com/organizations/some-org", "validation_client_name":"some-org-validator"}' -RunList "Apache" -Windows -``` - -This command adds the Chef extension to a Windows virtual machine named WindowsVM002. -When the virtual machine starts, Chef bootstraps the virtual machine to run Apache. -After bootstrapping, the virtual machine refers to the BootstrapOptions specified in JSON format. - -## PARAMETERS - -### -AutoUpgradeMinorVersion -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BootstrapOptions -Specifies configuration settings in the client_rb option. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BootstrapVersion -Specifies the version of the bootstrap configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChefDaemonInterval -Specifies the frequency (in minutes) at which the chef-service runs. If in case you don't want the chef-service to be installed on the Azure VM then set value as 0 in this field. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ChefServiceInterval - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChefServerUrl -Specifies the Chef server link, as a URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRb -Specifies the full path of the Chef client.rb. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Daemon -Configures the chef-client service for unattended execution. The node platform should be Windows. -Allowed options: 'none','service' and 'task'. -none - Currently prevents the chef-client service from being configured as a service. -service - Configures the chef-client to run automatically in the background as a service. -task - Configures the chef-client to run automatically in the background as a secheduled task. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: none, service, task - -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JsonAttribute -A JSON string to be added to the first run of chef-client. e.g. -JsonAttribute '{"foo" : "bar"}' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Linux -Indicates that this cmdlet creates a Windows virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Chef extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrganizationName -Specifies the organization name of the Chef extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunList -Specifies the Chef node run list. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -The encryption key used to encrypt and decrypt the data bag item values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretFile -The path to the file that contains the encryption key used to encrypt and decrypt the data bag item values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidationClientName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidationPem -Specifies the Chef validator .pem file path - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the Chef extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Windows -Indicates that this cmdlet creates a Windows virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMChefExtension](./Get-AzureRmVMChefExtension.md) - -[Remove-AzureRmVMChefExtension](./Remove-AzureRmVMChefExtension.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMCustomScriptExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMCustomScriptExtension.md deleted file mode 100644 index d126d0aeb7..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMCustomScriptExtension.md +++ /dev/null @@ -1,363 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 64AB1BAE-A756-43A8-A40F-10B746EA0946 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmcustomscriptextension -schema: 2.0.0 ---- - -# Set-AzureRmVMCustomScriptExtension - -## SYNOPSIS -Adds a custom script extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetCustomScriptExtensionByContainerAndFileNames (Default) -``` -Set-AzureRmVMCustomScriptExtension -ContainerName <String> -FileName <String[]> [-StorageAccountName <String>] - [-StorageEndpointSuffix <String>] [-StorageAccountKey <String>] [-Run <String>] [-Argument <String>] - [-SecureExecution] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetCustomScriptExtensionByUriLinks -``` -Set-AzureRmVMCustomScriptExtension [-FileUri <String[]>] [-Run <String>] [-Argument <String>] - [-SecureExecution] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMCustomScriptExtension** cmdlet adds a custom script Virtual Machine Extension to a virtual machine. -This extension lets you run your own scripts on the virtual machine. - -## EXAMPLES - -### Example 1: Add a custom script -``` -PS C:\> Set-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "1.1" -StorageAccountName "Contoso" -StorageAccountKey <StorageKey> -FileName "ContosoScript.exe" -ContainerName "Scripts" -``` - -This command adds a custom script to the virtual machine named VirtualMachine07. -The script file is contososcript.exe. - -## PARAMETERS - -### -Argument -Specifies arguments that the script extension passes to the script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContainerName -Specifies the name of the Azure storage container where this cmdlet stores the script. - -```yaml -Type: String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: True -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileName -Specifies the name of the script file. If the file is stored in Azure Blob storage, the file name -value is case-senstive. File names of files stored in Azure File storage are not case-senstive. - -```yaml -Type: String[] -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileUri -Specifies the URI of the script file. - -```yaml -Type: String[] -Parameter Sets: SetCustomScriptExtensionByUriLinks -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. - -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```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 custom script extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Run -Specifies the command to use that runs your script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RunFile, Command - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureExecution -Indicates that this cmdlet makes sure that the value of the *Run* parameter is not logged on the server or returned to the user by using the GET extension API. -The value of *Run* might contain secrets or passwords to be passed to the script file securely. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountKey -Specifies the key for the Azure storage container. - -```yaml -Type: String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountName -Specifies the name of the Azure storage account where this cmdlet stores the script. - -```yaml -Type: String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEndpointSuffix -Specifies the storage endpoint suffix. - -```yaml -Type: String -Parameter Sets: SetCustomScriptExtensionByContainerAndFileNames -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. -To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with a value of Microsoft.Compute for the *PublisherName* parameter and VMAccessAgent for the *Type* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet adds the custom script extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMCustomScriptExtension](./Get-AzureRmVMCustomScriptExtension.md) - -[Remove-AzureRmVMCustomScriptExtension](./Remove-AzureRmVMCustomScriptExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDiskEncryptionExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDiskEncryptionExtension.md deleted file mode 100644 index 3f55922753..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDiskEncryptionExtension.md +++ /dev/null @@ -1,591 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6BCB36BC-F5E6-4EDD-983C-8BDE7A9B004D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdiskencryptionextension -schema: 2.0.0 ---- - -# Set-AzureRmVMDiskEncryptionExtension - -## SYNOPSIS -Enables encryption on a running IaaS virtual machine in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### AADClientSecretParameterSet (Default) -``` -Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> - [-AadClientSecret] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> - [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] - [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] - [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] - [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AADClientCertParameterSet -``` -Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String> - [-AadClientCertThumbprint] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> - [[-KeyEncryptionKeyUrl] <String>] [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] - [[-VolumeType] <String>] [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] - [[-Passphrase] <String>] [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>] - [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDiskEncryptionExtension** cmdlet enables encryption on a running infrastructure as a service (IaaS) virtual machine in Azure. -This cmdlet enables encryption by installing the disk encryption extension on the virtual machine. -If no *Name* parameter is specified, an extension with the default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines are installed. -This cmdlet requires confirmation from the users as one of the steps to enable encryption requires a restart of the virtual machine. -It is advised that you save your work on the virtual machine before you run this cmdlet. - -## EXAMPLES - -### Example 1: Enable encryption using Azure AD Client ID and Client Secret -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -$AADClientID = "<clientID of your Azure AD app>" -$AADClientSecret = "<clientSecret of your Azure AD app>" -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Azure AD client ID, and client secret. - -### Example 2: Enable encryption using Azure AD client ID and client certification thumbprint -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -#The KeyVault must have enabledForDiskEncryption property set on it -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId - -# create Azure AD application and associate the certificate -$CertPath = "C:\certificates\examplecert.pfx" -$CertPassword = "Password" -$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) -$KeyValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) -$AzureAdApplication = New-AzureRmADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -KeyValue $KeyValue -KeyType AsymmetricX509Cert -$ServicePrincipal = New-AzureRmADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId - -$AADClientID = $AzureAdApplication.ApplicationId -$aadClientCertThumbprint= $cert.Thumbprint - -#Upload pfx to KeyVault -$KeyVaultSecretName = "MyAADCert" -$FileContentBytes = get-content $CertPath -Encoding Byte -$FileContentEncoded = [System.Convert]::ToBase64String($fileContentBytes) -$JSONObject = @" - { - "data" : "$filecontentencoded", - "dataType" : "pfx", - "password" : "$CertPassword" - } -"@ -$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($jsonObject) -$JSONEncoded = [System.Convert]::ToBase64String($jsonObjectBytes) - -$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force -Set-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName -SecretValue $Secret -Set-AzureRmKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment - -#deploy cert to VM -$CertUrl = (Get-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id -$SourceVaultId = (Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId -$VM = Get-AzureRmVM -ResourceGroupName $RGName -Name $VMName -$VM = Add-AzureRmVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl -Update-AzureRmVM -VM $VM -ResourceGroupName $RGName - -#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Azure AD client ID and client certification thumbprints. - -### Example 3: Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" - -$AADClientID = "<clientID of your Azure AD app>" -$AADClientSecret = "<clientSecret of your Azure AD app>" - -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId - -$KEK = Add-AzureKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" -$KeyEncryptionKeyUrl = $KEK.Key.kid - -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Azure AD client ID, client secret, and wrap disk encryption key by using the key encryption key. - -### Example 4: Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key -``` -$RGName = "MyResourceGroup" -$VMName = "MyTestVM" -#The KeyVault must have enabledForDiskEncryption property set on it -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -$KEK = Add-AzureKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software" -$KeyEncryptionKeyUrl = $KEK.Key.kid - -# create Azure AD application and associate the certificate -$CertPath = "C:\certificates\examplecert.pfx" -$CertPassword = "Password" -$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword) -$KeyValue = [System.Convert]::ToBase64String($cert.GetRawCertData()) -$AzureAdApplication = New-AzureRmADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -KeyValue $KeyValue -KeyType AsymmetricX509Cert -$ServicePrincipal = New-AzureRmADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId - -$AADClientID = $AzureAdApplication.ApplicationId -$AADClientCertThumbprint= $Cert.Thumbprint - -#Upload pfx to KeyVault -$KeyVaultSecretName = "MyAADCert" -$FileContentBytes = get-content $CertPath -Encoding Byte -$FileContentEncoded = [System.Convert]::ToBase64String($FileContentBytes) -$JSONObject = @" - { - "data" : "$filecontentencoded", - "dataType" : "pfx", - "password" : "$CertPassword" - } -"@ -$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($JSONObject) -$JsonEncoded = [System.Convert]::ToBase64String($JSONObjectBytes) -$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force -Set-AzureKeyVaultSecret -VaultName $VaultName-Name $KeyVaultSecretName -SecretValue $Secret -Set-AzureRmKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment - -#deploy cert to VM -$CertUrl = (Get-AzureKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id -$SourceVaultId = (Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId -$VM = Get-AzureRmVM -ResourceGroupName $RGName -Name $VMName -$VM = Add-AzureRmVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl -Update-AzureRmVM -VM $VM -ResourceGroupName $RGName - -#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint -Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGname -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This example enables encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryption key by using key encryption key. - -## PARAMETERS - -### -AadClientCertThumbprint -Specifies the thumbprint of the AzureActive Directory (Azure AD) application client certificate that has permissions to write secrets to **KeyVault**. -As a prerequisite, the Azure AD client certificate must be previously deployed to the virtual machine's local computer `my` certificate store. -The Add-AzureRmVMSecret cmdlet can be used to deploy a certificate to a virtual machine in Azure. -For more details, see the **Add-AzureRmVMSecret** cmdlet help. -The certificate must be previously deployed to the virtual machine local computer my certificate store. - -```yaml -Type: String -Parameter Sets: AADClientCertParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AadClientID -Specifies the client ID of the Azure AD application that has permissions to write secrets to **KeyVault**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AadClientSecret -Specifies the client secret of the Azure AD application that has permissions to write secrets to **KeyVault**. - -```yaml -Type: String -Parameter Sets: AADClientSecretParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -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 -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet disables auto-upgrade of the minor version of the extension. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -Specifies the resource ID of the **KeyVault** to which the virtual machine encryption keys should be uploaded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultUrl -Specifies the **KeyVault** URL to which the virtual machine encryption keys should be uploaded. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptFormatAll -Encrypt-Format all data drives that are not already encrypted - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionPublisherName -The extension publisher name. Specify this parameter only to override the default value of "Microsoft.Azure.Security". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -The extension type. Specify this parameter to override its default value of "AzureDiskEncryption" for Windows VMs and "AzureDiskEncryptionForLinux" for Linux VMs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionAlgorithm -Specifies the algorithm that is used to wrap and unwrap the key encryption key of the virtual machine. -The default value is RSA-OAEP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: RSA-OAEP, RSA1_5 - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Specifies the URL of the key encryption key that is used to wrap and unwrap the virtual machine encryption key. -This must be the full versioned URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -Specifies the resource ID of the **KeyVault** that contains key encryption key that is used to wrap and unwrap the virtual machine encryption key. -This must be a full versioned URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Azure Resource Manager resource that represents the extension. -The default value is AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passphrase -Specifies the passphrase used for encrypting Linux virtual machines only. -This parameter is not used for virtual machines that run the Windows operating system. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 13 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SequenceVersion -Specifies the sequence number of the encryption operations for a virtual machine. -This is unique per each encryption operation performed on the same virtual machine. -The Get-AzureRmVMExtension cmdlet can be used to retrieve the previous sequence number that was used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipVmBackup -Skip backup creation for Linux VMs - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the encryption extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Specifies the type of virtual machine volumes to perform the encryption operation. -Allowed values for virtual machines that run the Windows operating system are as follows: All, OS, and Data. -The allowed values for Linux virtual machines are as follows: Data only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: 9 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMSecret](./Add-AzureRmVMSecret.md) - -[Get-AzureRmVMDiskEncryptionStatus](./Get-AzureRmVMDiskEncryptionStatus.md) - -[Remove-AzureRmVMDiskEncryptionExtension](./Remove-AzureRmVMDiskEncryptionExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDscExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDscExtension.md deleted file mode 100644 index e871cc9ba0..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMDscExtension.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 04F58D88-53D6-42CA-852C-9E2A129898C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmdscextension -schema: 2.0.0 ---- - -# Set-AzureRmVMDscExtension - -## SYNOPSIS -Configures the DSC extension on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMDscExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-ArchiveBlobName] <String> [-ArchiveStorageAccountName] <String> [-ArchiveResourceGroupName <String>] - [-ArchiveStorageEndpointSuffix <String>] [-ArchiveContainerName <String>] [-ConfigurationName <String>] - [-ConfigurationArgument <Hashtable>] [-ConfigurationData <String>] [-Version] <String> [-Force] - [-Location <String>] [-AutoUpdate] [-WmfVersion <String>] [-DataCollection <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMDscExtension** cmdlet configures the Windows PowerShell Desired State Configuration (DSC) extension on a virtual machine in a resource group. - -## EXAMPLES - -### Example 1: Set a DSC extension -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US" -``` - -This command sets the DSC extension on the virtual machine named VM07 to download Sample.ps1.zip from the storage account named Stg and the default container. -The command invokes the configuration named ConfigName. -The Sample.ps1.zip file was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -### Example 2: Set a DSC extension with configuration data -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -``` - -This command sets the extension on the virtual machine named VM13 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. -The command the configuration named ConfigName and specifies configuration data and arguments. -The Sample.ps1.zip file was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -### Example 3: Set a DSC extension with configuration data that has auto update -``` -PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate -``` - -This command sets the extension on the virtual machine named VM22 to download Sample.ps1.zip from the storage account named Stg and the container named WindowsPowerShellDSC. -The command invokes the configuration named ConfigName and specifies configuration data and arguments. -This command also enables auto update of extension handler to the latest version. -The Sample.ps1.zip was previously uploaded by using **Publish-AzureRmVMDscConfiguration**. - -## PARAMETERS - -### -ArchiveBlobName -Specifies the name of the configuration file that was previously uploaded by the Publish-AzureRmVMDscConfiguration cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConfigurationArchiveBlob - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveContainerName -Species name of the Azure storage container where the configuration archive is located. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ContainerName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveResourceGroupName -Specifies the name of the resource group that contains the storage account that contains the configuration archive. -This parameter is optional if the storage account and virtual machine are both in the same resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveStorageAccountName -Specifies the Azure storage account name that is used to download the ArchiveBlobName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ArchiveStorageEndpointSuffix -Specifies the storage endpoint suffix. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageEndpointSuffix - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoUpdate -Specifies the extension handler version specified by the *Version* parameter. -By default extension handler is not autoupdated. -Use the *AutoUpdate* parameter to enable auto update of the extension handler to the latest version as and when it is available. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationArgument -Specifies a hash table that contains the arguments to the configuration function. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationData -Specifies the path of a .psd1 file that specifies the data for the configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the name of the configuration that the DSC Extension invokes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataCollection -Specifies the data collection type. -The acceptable values for this parameter are: Enable and Disable. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Enable, Disable - -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. - -```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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the path of the resource extension. - -```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 Azure Resource Manager resource that represents the extension. -The default value is Microsoft.Powershell.DSC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the DSC extension that Set-AzureRmVMDscExtension applies the settings to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine where DSC extension handler is installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WmfVersion -Specifies the WMF version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: 4.0, 5.0, 5.1, latest - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMDscExtension](./Get-AzureRmVMDscExtension.md) - -[Remove-AzureRmVMDscExtension](./Remove-AzureRmVMDscExtension.md) - -[Publish-AzureRmVMDscConfiguration](./Publish-AzureRmVMDscConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMExtension.md deleted file mode 100644 index 30a53dbda1..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMExtension.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 064196C3-ABF3-4F3A-A4AB-EB0D27098C70 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmextension -schema: 2.0.0 ---- - -# Set-AzureRmVMExtension - -## SYNOPSIS -Updates extension properties or adds an extension to a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Settings (Default) -``` -Set-AzureRmVMExtension -Publisher <String> -ExtensionType <String> [-Settings <Hashtable>] - [-ProtectedSettings <Hashtable>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SettingString -``` -Set-AzureRmVMExtension -Publisher <String> -ExtensionType <String> [-SettingString <String>] - [-ProtectedSettingString <String>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>] - [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMExtension** cmdlet updates properties for existing Virtual Machine Extensions or adds an extension to a virtual machine. - -## EXAMPLES - -### Example 1: Modify settings by using hash tables -``` -PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""}; -PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey}; -PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings; -``` - -The first two commands use standard Windows PowerShell syntax to create hash tables, and then stores those hash tables in the $Settings and $ProtectedSettings variables. -For more information, type `Get-Help about_Hash_Tables`. -The second command includes two values previously created and stored in variables. - -The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $Settings and $ProtectedSettings. -The command specifies other required information that includes the publisher and the extension type. - -### Example 2: Modify settings by using strings -``` -PS C:\> $SettingsString = '{"fileUris":[],"commandToExecute":""}'; -PS C:\> $ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}'; -PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ; -``` - -The first two commands create strings that contain settings, and then stores them in the $SettingsString and $ProtectedSettingsString variables. - -The final command modifies an extension of the virtual machine named VirtualMachine22 in ResourceGroup11 according to the contents of $SettingsString and $ProtectedSettingsString. -The command specifies other required information that includes the publisher and the extension type. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoUpgradeMinorVersion -Indicates that this cmdlet prevents the Azure guest agent from automatically updating the extensions to a newer minor version. -By default, this cmdlet enables the guest agent to update the extensions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionType -Specifies the extension type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Type - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceRerun -Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the extension. -The value can be any string different from the current value. - -If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the virtual machine. - -```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 an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ExtensionName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettings -Specifies private configuration for the extension, as a hash table. -This cmdlet encrypts the private configuration. - -```yaml -Type: Hashtable -Parameter Sets: Settings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedSettingString -Specifies private configuration for the extension, as a string. -This cmdlet encrypts the private configuration. - -```yaml -Type: String -Parameter Sets: SettingString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the name of the extension publisher. -The publisher provides a name when the publisher registers an extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Settings -Specifies public configuration for the extension, as a hash table. -This cmdlet does not encrypt public configuration. - -```yaml -Type: Hashtable -Parameter Sets: Settings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SettingString -Specifies public configuration for the extension, as a string. -This cmdlet does not encrypt public configuration. - -```yaml -Type: String -Parameter Sets: SettingString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -Specifies the version of the extension to use for this virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet modifies extensions for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMExtension](./Get-AzureRmVMExtension.md) - -[Remove-AzureRmVMExtension](./Remove-AzureRmVMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOSDisk.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOSDisk.md deleted file mode 100644 index f3c07e7358..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOSDisk.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 8F7AF1B8-D769-452C-92CF-4486C3EB894D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmosdisk -schema: 2.0.0 ---- - -# Set-AzureRmVMOSDisk - -## SYNOPSIS -Sets the operating system disk properties on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParamSet (Default) -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <DiskCreateOptionTypes>] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <StorageAccountTypes>] - [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsParamSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <DiskCreateOptionTypes>] [-Windows] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <StorageAccountTypes>] - [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsDiskEncryptionParameterSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <DiskCreateOptionTypes>] [-Windows] - [-DiskEncryptionKeyUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] - [[-KeyEncryptionKeyVaultId] <String>] [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] - [-StorageAccountType <StorageAccountTypes>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### LinuxParamSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <DiskCreateOptionTypes>] [-Linux] - [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] [-StorageAccountType <StorageAccountTypes>] - [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### LinuxDiskEncryptionParameterSet -``` -Set-AzureRmVMOSDisk [-VM] <PSVirtualMachine> [[-Name] <String>] [[-VhdUri] <String>] - [[-Caching] <CachingTypes>] [[-SourceImageUri] <String>] [[-CreateOption] <DiskCreateOptionTypes>] [-Linux] - [-DiskEncryptionKeyUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>] - [[-KeyEncryptionKeyVaultId] <String>] [-DiskSizeInGB <Int32>] [-ManagedDiskId <String>] - [-StorageAccountType <StorageAccountTypes>] [-WriteAccelerator] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMOSDisk** cmdlet sets the operating system disk properties on a virtual machine. - -## EXAMPLES - -### Example 1: Set properties on a virtual machine from platform image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) -PS C:\> $VirtualMachine = Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName "Canonical" -Offer "UbuntuServer" -Skus "15.10" -Version "latest" -Caching ReadWrite -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption FromImage -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 2: Sets properties on a virtual machine from generalized user image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Linux -ComputerName "MainComputer" -Credential (Get-Credential) -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -SourceImageUri "https://mystorageaccount.blob.core.windows.net/vhds/myOSImage.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption fromImage -Linux -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 3: Sets properties on a virtual machine from specialized user image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet13" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:\> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "osDisk.vhd" -VhdUri "https://mystorageaccount.blob.core.windows.net/disks/" -CreateOption Attach -Linux -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName "ResourceGroup11" -``` - -The first command gets the availability set named AvailablitySet13 in the resource group named ResourceGroup11 and stores that object in the $AvailabilitySet variable. -The second command creates a virtual machine object and stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. -The final command sets the properties on the virtual machine in $VirtualMachine. - -### Example 4: Set the disk encryption settings on a virtual machine operating system disk -``` -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine17" -VMSize "Standard_A1" -PS C:> $VirtualMachine = Set-AzureRmVMOSDisk -VM $VirtualMachine -Name "OsDisk12" -VhdUri "os.vhd" -Caching ReadWrite -Windows -CreateOption "Attach" -DiskEncryptionKeyUrl "https://mytestvault.vault.azure.net/secrets/Test1/514ceb769c984379a7e0230bddaaaaaa" -DiskEncryptionKeyVaultId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mytestvault" -PS C:> New-AzureRmVM -VM $VirtualMachine -ResouceGroupName " ResourceGroup11" -``` - -This example sets the disk encryption settings on a virtual machine operating system disk. - -## PARAMETERS - -### -Caching -Specifies the caching mode of the operating system disk. -Valid values are: - -- ReadOnly -- ReadWrite - -The default value is ReadWrite. -Changing the caching value causes the virtual machine to restart. - -This setting affects the performance of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateOption -Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, or attaches an existing disk. -Valid values are: - -- Attach. -Specify this option to create a virtual machine from a specialized disk. -When you specify this option, do not specify the *SourceImageUri* parameter. -Instead, use the Set-AzureRmVMSourceImage cmdlet. -You must also use the use the *Windows* or *Linux* parameters to tell the azure2 platform the type of the operating system on the VHD. -The *VhdUri* parameter is enough to tell the azure2 platform the location of the disk to attach. -- FromImage. -Specify this option to create a virtual machine from a platform image or a generalized user image. -In the case of a generalized user image, you also need to specify the *SourceImageUri* parameter and either the *Windows* or *Linux* parameters to tell the Azure platform the location and type of the operating system disk VHD instead of using the **Set-AzureRmVMSourceImage** cmdlet. -In the case of a platform image, the *VhdUri* parameter is sufficient. -- Empty. - -```yaml -Type: DiskCreateOptionTypes -Parameter Sets: (All) -Aliases: -Accepted values: FromImage, Empty, Attach - -Required: False -Position: 5 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyUrl -Specifies the location of the disk encryption key. - -```yaml -Type: String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -Specifies the resource ID of the Key Vault containing the disk encryption key. - -```yaml -Type: String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: True -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskSizeInGB -Specifies the size, in GB, of the operating system disk. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Specifies the location of the key encryption key. - -```yaml -Type: String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -Specifies the resource ID of the Key Vault containing the key encryption key. - -```yaml -Type: String -Parameter Sets: WindowsDiskEncryptionParameterSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Linux -Indicates that the operating system on the user image is Linux. -Specify this parameter for user image based virtual machine deployment. - -```yaml -Type: SwitchParameter -Parameter Sets: LinuxParamSet, LinuxDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedDiskId -Specifies the ID of a managed disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the operating system disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OSDiskName, DiskName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceImageUri -Specifies the URI of the VHD for user image scenarios. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SourceImage - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageAccountType -Specifies the storage account type of managed disk. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdUri -Specifies the Uniform Resource Identifier (URI) of a virtual hard disk (VHD). - -For an image based virtual machine, this parameter specifies the VHD file to create when a platform image or user image is specified. -This is the location from which the image binary large object (BLOB) is copied to start the virtual machine. - -For a disk based virtual machine boot scenario, this parameter specifies the VHD file that the virtual machine uses directly for starting up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OSDiskVhdUri, DiskVhdUri - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object on which to set operating system disk properties. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the operating system on the user image is Windows. - -```yaml -Type: SwitchParameter -Parameter Sets: WindowsParamSet, WindowsDiskEncryptionParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOperatingSystem.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOperatingSystem.md deleted file mode 100644 index 52b2b5e8d3..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMOperatingSystem.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 39AADD19-2EDD-4C1F-BC9E-22186DD9A085 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmoperatingsystem -schema: 2.0.0 ---- - -# Set-AzureRmVMOperatingSystem - -## SYNOPSIS -Sets operating system properties for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Windows (Default) -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### WindowsWinRmHttps -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Windows] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-ProvisionVMAgent] [-EnableAutoUpdate] - [[-TimeZone] <String>] [-WinRMHttp] [-WinRMHttps] [-WinRMCertificateUrl] <Uri> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Linux -``` -Set-AzureRmVMOperatingSystem [-VM] <PSVirtualMachine> [-Linux] [-ComputerName] <String> - [-Credential] <PSCredential> [[-CustomData] <String>] [-DisablePasswordAuthentication] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMOperatingSystem** cmdlet sets operating system properties for a virtual machine. -You can specify logon credentials, computer name, and operating system type. - -## EXAMPLES - -### Example 1: Set operating system properties for a new virtual machines -``` -PS C:\> $SecurePassword = ConvertTo-SecureString "Password" -AsPlainText -Force -PS C:\> $Credential = New-Object System.Management.Automation.PSCredential ("FullerP", $SecurePassword); -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> $ComputerName = "ContosoVM122" -PS C:\> $WinRMCertUrl = "http://keyVaultName.vault.azure.net/secrets/secretName/secretVersion" -PS C:\> $TimeZone = "Pacific Standard Time" -PS C:\> $CustomData = "echo 'Hello World'" -PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $$VirtualMachine -Windows -ComputerName $ComputerName -Credential $Credential -CustomData $CustomData -WinRMHttp -WinRMHttps -WinRMCertificateUrl $WinRMCertUrl -ProvisionVMAgent -EnableAutoUpdate -TimeZone $TimeZone -``` - -The first command converts a password to a secure string, and then stores it in the $SecurePassword variable. -For more information, type `Get-Help ConvertTo-SecureString`. - -The second command creates a credential for the user FullerP and the password stored in $SecurePassword, and then stores the credential in the $Credential variable. -For more information, type `Get-Help New-Object`. - -The third command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. - -The fourth command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. - -The next four commands assign values to variables to use in the following command. -Because you could specify these strings directly in the **Set-AzureRmVMOperatingSystem** command, this approach is used only for readability. -However, you might use an approach such as this in scripts. - -The final command sets operating system properties for the virtual machine stored in $VirtualMachine. -The command uses the credentials stored in $Credential. -The command uses variables assigned in previous commands for some parameters. - -## PARAMETERS - -### -ComputerName -Specifies the name of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password for the virtual machine as a **PSCredential** object. -To obtain a credential, use the Get-Credential cmdlet. -For more information, type `Get-Help Get-Credential`. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -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 -``` - -### -DisablePasswordAuthentication -Indicates that this cmdlet disables password authentication. - -```yaml -Type: SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAutoUpdate -Indicates that this cmdlet enables auto update. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Linux -Indicates that the type of operating system is Linux. - -```yaml -Type: SwitchParameter -Parameter Sets: Linux -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProvisionVMAgent -Indicates that the settings require that the virtual machine agent be installed on the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for the virtual machine. - -```yaml -Type: String -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object on which to set operating system properties. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. -Create a virtual machine object by using the New-AzureRmVMConfig cmdlet. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Windows -Indicates that the type of operating system is Windows. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMCertificateUrl -Specifies the URI of a WinRM certificate. -This needs to be stored in a Key Vault. - -```yaml -Type: Uri -Parameter Sets: WindowsWinRmHttps -Aliases: - -Required: True -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMHttp -Indicates that this operating system uses HTTP WinRM. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows, WindowsWinRmHttps -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinRMHttps -Indicates that this operating system uses HTTPS WinRM. - -```yaml -Type: SwitchParameter -Parameter Sets: WindowsWinRmHttps -Aliases: - -Required: True -Position: 9 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMPlan.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMPlan.md deleted file mode 100644 index 98dabb1905..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMPlan.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: A1EA7D34-A8B4-4FA0-BD8C-3E846715AFBA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmplan -schema: 2.0.0 ---- - -# Set-AzureRmVMPlan - -## SYNOPSIS -Sets the Marketplace plan information on a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVMPlan [-VM] <PSVirtualMachine> [-Name] <String> [[-Product] <String>] [[-PromotionCode] <String>] - [[-Publisher] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMPlan** cmdlet sets the Azure Marketplace plan information for a virtual machine. - -Before being able to deploy a Marketplace image through the command-line, programmatic access must be enabled or the virtual machine must be deployed by using the Azure portal. - -## EXAMPLES - -## 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 -Specifies the name of the image from the Marketplace. -This is the same value that is returned by the Get-AzureRmVMImageSku cmdlet. -For more information about how to find image information, see [Find and use Azure Marketplace VM images with Azure PowerShell](/azure/virtual-machines/windows/cli-ps-findimage) in the Microsoft Azure documentation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Product -Specifies the product of the image from the Marketplace. -This is the same information as the **Offer** value of the **imageReference** element. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PromotionCode -Specifies a promotion code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the publisher of the image. -You can find this information by using the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object for which to set a Marketplace plan. -You can use the Get-AzureRmVM cmdlet to obtain a virtual machine object. -You can use the New-AzureRmVMConfig cmdlet to create a virtual machine object. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMSourceImage.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMSourceImage.md deleted file mode 100644 index f909719c21..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVMSourceImage.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 91B2DE2F-442D-4428-8A6F-9C2CEC181CA7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmsourceimage -schema: 2.0.0 ---- - -# Set-AzureRmVMSourceImage - -## SYNOPSIS -Specifies the image for a virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImageReferenceSkuParameterSet (Default) -``` -Set-AzureRmVMSourceImage [-VM] <PSVirtualMachine> [-PublisherName] <String> [-Offer] <String> [-Skus] <String> - [-Version] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ImageReferenceIdParameterSet -``` -Set-AzureRmVMSourceImage [-VM] <PSVirtualMachine> [-Id] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVMSourceImage** cmdlet specifies the platform image to use for a virtual machine. - -## EXAMPLES - -### Example 1: Set values for an image -``` -PS C:\> $AvailabilitySet = Get-AzureRmAvailabilitySet -ResourceGroupName "ResourceGroup11" -Name "AvailabilitySet03" -PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id -PS C:\> Set-AzureRmVMSourceImage -VM $VirtualMachine -PublisherName "MicrosoftWindowsServer" -Offer "WindowsServer" -Skus "2012-R2-Datacenter" -Version "latest" -``` - -The first command gets the availability set named AvailablitySet03 in the resource group named ResourceGroup11, and then stores that object in the $AvailabilitySet variable. - -The second command creates a virtual machine object, and then stores it in the $VirtualMachine variable. -The command assigns a name and size to the virtual machine. -The virtual machine belongs to the availability set stored in $AvailabilitySet. - -The final command sets values for publisher name, offer, SKU, and version. -The **Get-AzureRmVMImagePublisher**, **Get-AzureRmVMImageOffer**, **Get-AzureRmVMImageSku**, and **Get-AzureRmVMImage** cmdlets can discover these settings. - -## 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 -``` - -### -Id -Specifies the ID. - -```yaml -Type: String -Parameter Sets: ImageReferenceIdParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Offer -Specifies the type of VMImage offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublisherName -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skus -Specifies a VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies a version of a VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: String -Parameter Sets: ImageReferenceSkuParameterSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the local virtual machine object to configure. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAvailabilitySet](./Get-AzureRmAvailabilitySet.md) - -[Get-AzureRmVMImage](./Get-AzureRmVMImage.md) - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmss.md deleted file mode 100644 index 0234c518e7..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmss.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 6442E5BB-D59D-483B-8AC5-2586C6C1E925 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmss -schema: 2.0.0 ---- - -# Set-AzureRmVmss - -## SYNOPSIS -Sets specific actions on a specified VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Reimage] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Set-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] - [-ReimageAll] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmss** cmdlet sets specific actions on the Virtual Machine Scale Set (VMSS). -The only action this cmdlet supports is Reimage. - -## EXAMPLES - -### Example 1: Reimage a VMSS -``` -PS C:\> Set-AzureRmVmss -Reimage -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command reimages the VMSS named ContosoVMSS that belongs to the resource group named ContosoGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -The instance ID of the virtual machine. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Reimage -Indicates that the cmdlet reimages the VMSS. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReimageAll -Indicates that the cmdlet reimages all the disks in the VMSS. - -```yaml -Type: SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Species the name of the VMSS for which this cmdlet sets actions on. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssBootDiagnostic.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssBootDiagnostic.md deleted file mode 100644 index 845ba66542..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssBootDiagnostic.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssbootdiagnostic -schema: 2.0.0 ---- - -# Set-AzureRmVmssBootDiagnostic - -## SYNOPSIS -Sets the virtual machine scale set boot diagnostics profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssBootDiagnostic [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Enabled] <Boolean>] - [[-StorageUri] <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the virtual machine scale set boot diagnostics profile. - -## EXAMPLES - -### Example 1: Set the boot diagnostics profile property for a VMSS -``` -PS C:\> $vmss = New-AzureRmVmssConfig -Location $loc -SkuCapacity 2 -SkuName 'Standard_A0' -PS C:\> Set-AzureRmVmssBootDiagnostic -VirtualMachineScaleSet $vmss -Enabled $true -StorageUri $storageUri; -PS C:\> New-AzureRmVmss -ResourceGroupName $rgname -Name "ContosoVMSS" -VirtualMachineScaleSet $vmss; -``` - -This command sets boot diagnostics profile property for the VMSS named ContosoVMSS. - -## 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 -``` - -### -Enabled -Whether boot diagnostics should be enabled on the virtual machine scale set. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageUri -URI of the storage account to use for placing the console output and screenshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet -System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] -System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Compute.Models.VirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssDiskEncryptionExtension.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssDiskEncryptionExtension.md deleted file mode 100644 index 1006d255f6..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssDiskEncryptionExtension.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssdiskencryptionextension -schema: 2.0.0 ---- - -# Set-AzureRmVmssDiskEncryptionExtension - -## SYNOPSIS -Enables disk encryption on a VM scale set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssDiskEncryptionExtension [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [-KeyEncryptionKeyUrl <String>] - [-KeyEncryptionKeyVaultId <String>] [-KeyEncryptionAlgorithm <String>] [-VolumeType <String>] [-ForceUpdate] - [-TypeHandlerVersion <String>] [-ExtensionName <String>] [-Passphrase <String>] [-Force] - [-DisableAutoUpgradeMinorVersion] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssDiskEncryptionExtension** cmdlet enables encryption on a VM scale set. -This cmdlet enables encryption by installing the disk encryption extension on the VM scale set. -If no *Name* parameter is specified, an extension with the default name AzureDiskEncryption for virtual machines that run the Windows operating system or AzureDiskEncryptionForLinux for Linux virtual machines are installed. - -## EXAMPLES - -### Example 1 -``` -$RGName = "MyResourceGroup" -$VmssName = "MyTestVmss" -$VaultName= "MyKeyVault" -$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName -$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri -$KeyVaultResourceId = $KeyVault.ResourceId -PS C:\> Set-AzureRmVmssDiskEncryptionExtension -ResourceGroupName $RGName -VMScaleSetName $VmssName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -``` - -This command enables encryption on all disks of all VMs in the VM scale set. - -## 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 -``` - -### -DisableAutoUpgradeMinorVersion -Disable auto-upgrade of minor version - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultId -ResourceID of the KeyVault where generated encryption key will be placed to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskEncryptionKeyVaultUrl -URL of the KeyVault where generated encryption key will be placed to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionName -The extension name. -If this parameter is not specified, default values used are AzureDiskEncryption for windows VMs and AzureDiskEncryptionForLinux for Linux VMs - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -To force enabling encryption on the virtual machine scale set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceUpdate -Generate a tag for force update. This should be given to perform repeated encryption operations on the same VM. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionAlgorithm -KeyEncryption Algorithm used to encrypt the volume encryption key - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: RSA-OAEP, RSA1_5 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyUrl -Versioned KeyVault URL of the KeyEncryptionKey used to encrypt the disk encryption key - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyEncryptionKeyVaultId -ResourceID of the KeyVault containing the KeyEncryptionKey used to encrypt the disk encryption key - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passphrase -The passphrase specified in parameters. -This parameter only works for Linux VM. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name to which the VM Scale Set belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TypeHandlerVersion -The type handler version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: HandlerVersion, Version - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Name of the virtual machine scale set - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeType -Type of the volume (OS or Data) to perform encryption operation - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OS, Data, All - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineScaleSetExtension - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssOsProfile.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssOsProfile.md deleted file mode 100644 index 68f5c4106a..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssOsProfile.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 3E7B9EFA-8BC2-46EB-9AD7-43EAB7FF3891 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssosprofile -schema: 2.0.0 ---- - -# Set-AzureRmVmssOsProfile - -## SYNOPSIS -Sets the VMSS operating system profile properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssOsProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-ComputerNamePrefix] <String>] - [[-AdminUsername] <String>] [[-AdminPassword] <String>] [[-CustomData] <String>] - [[-WindowsConfigurationProvisionVMAgent] <Boolean>] [[-WindowsConfigurationEnableAutomaticUpdate] <Boolean>] - [[-TimeZone] <String>] [[-AdditionalUnattendContent] <AdditionalUnattendContent[]>] - [[-Listener] <WinRMListener[]>] [[-LinuxConfigurationDisablePasswordAuthentication] <Boolean>] - [[-PublicKey] <SshPublicKey[]>] [[-Secret] <VaultSecretGroup[]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssOsProfile** cmdlet sets the Virtual Machine Scale Set operating system profile properties. - -## EXAMPLES - -### Example 1: Set the operating system profile properties for a VMSS -``` -PS C:\> Set-AzureRmVmssOSProfile -VirtualMachineScaleSet "ContosoVMSS" -ComputerNamePrefix "Test" -AdminUsername $AdminUsername -AdminPassword $AdminPassword -``` - -This command sets operating system profile properties for the virtual machines that belong to the VMSS named ContosoVMSS. -The command sets the computer name prefix for all the virtual machine instances in the VMSS to Test and supplies the administrator username and password. - -## PARAMETERS - -### -AdditionalUnattendContent -Specifies an unattended content object. -You can use the Add-AzureRmVMAdditionalUnattendContent to create the object. - -```yaml -Type: AdditionalUnattendContent[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdminPassword -Specifies the administrator password to use for all the virtual machine instances in the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AdminUsername -Specifies the administrator account name to use for all the virtual machine instances in the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerNamePrefix -Specifies the computer name prefix for all the virtual machine instances in the VMSS. -Computer names must be 1 to 15 characters long. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -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 -``` - -### -LinuxConfigurationDisablePasswordAuthentication -Indicates that this cmdlet disables password authentication. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Listener -Specifies the Windows Remote Management (WinRM) listeners. -This enables remote Windows PowerShell. -You can use the Add-AzureRmVmssWinRMListener cmdlet to create the listener. - -```yaml -Type: WinRMListener[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicKey -Specifies the Secure Shell (SSH) public key object. -You can use the Add-AzureRmVMSshPublicKey cmdlet to create the object. - -```yaml -Type: SshPublicKey[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Specifies the secrets object which contains the certificate references to place on the virtual machine. -You can use the Add-AzureRmVmssSecret cmdlet to create the secrets object. - -```yaml -Type: VaultSecretGroup[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WindowsConfigurationEnableAutomaticUpdate -Indicates whether the virtual machines in the VMSS are enabled for automatic updates. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsConfigurationProvisionVMAgent -Indicates whether virtual machine agent should be provisioned on the virtual machines in the VMSS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVMAdditionalUnattendContent](./Add-AzureRmVMAdditionalUnattendContent.md) - -[Add-AzureRmVmssWinRMListener](./Add-AzureRmVmssWinRMListener.md) - -[Add-AzureRmVMSshPublicKey](./Add-AzureRmVMSshPublicKey.md) - -[Add-AzureRmVmssSecret](./Add-AzureRmVmssSecret.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssRollingUpgradePolicy.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssRollingUpgradePolicy.md deleted file mode 100644 index e25c49d742..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssRollingUpgradePolicy.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssrollingupgradepolicy -schema: 2.0.0 ---- - -# Set-AzureRmVmssRollingUpgradePolicy - -## SYNOPSIS -Sets the VMSS rolling upgrade policy properties. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssRollingUpgradePolicy [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-MaxBatchInstancePercent] <Int32>] [[-MaxUnhealthyInstancePercent] <Int32>] - [[-MaxUnhealthyUpgradedInstancePercent] <Int32>] [-PauseTimeBetweenBatches <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets the VMSS rolling upgrade policy properties. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmVmssRollingUpgradePolicy -VirtualMachineScaleSet $vmss -VirtualMachineScaleSet $vmss -MaxBatchInstancePercent 40 -MaxUnhealthyInstancePercent 35 -MaxUnhealthyUpgradedInstancePercent 30 -PauseTimeBetweenBatches "PT30S" -``` - -This command sets 40 percent for MaxBatchInstance, 35 percent for MaxUnhealthyInstance, 30 percent for MaxUnhealthyUpgradedInstance and 30 second pause time between batches for VMSS local object $vmss. - -## 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 -``` - -### -MaxBatchInstancePercent -The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. -As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxUnhealthyInstancePercent -The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. -This constraint will be checked prior to starting any batch. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxUnhealthyUpgradedInstancePercent -The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. -This check will happen after each batch is upgraded. -If this percentage is ever exceeded, the rolling update aborts. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PauseTimeBetweenBatches -The wait time between completing the update for all virtual machines in one batch and starting the next batch. -The time duration should be specified in ISO 8601 format. -The default value is 0 seconds (PT0S). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -You can use the New-AzureRmVmssConfig cmdlet to create the object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet -System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssStorageProfile.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssStorageProfile.md deleted file mode 100644 index a078cdf855..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssStorageProfile.md +++ /dev/null @@ -1,364 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 230DAE05-C197-451F-A24C-F4A2DAE4AD04 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssstorageprofile -schema: 2.0.0 ---- - -# Set-AzureRmVmssStorageProfile - -## SYNOPSIS -Sets the storage profile properties for the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVmssStorageProfile [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> - [[-ImageReferencePublisher] <String>] [[-ImageReferenceOffer] <String>] [[-ImageReferenceSku] <String>] - [[-ImageReferenceVersion] <String>] [[-OsDiskName] <String>] [[-OsDiskCaching] <CachingTypes>] - [[-OsDiskCreateOption] <DiskCreateOptionTypes>] [[-OsDiskOsType] <OperatingSystemTypes>] [[-Image] <String>] - [[-VhdContainer] <String[]>] [-ImageReferenceId <String>] [-OsDiskWriteAccelerator] - [-ManagedDisk <StorageAccountTypes>] [-DataDisk <VirtualMachineScaleSetDataDisk[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssStorageProfile** cmdlet sets the storage profile properties for the Virtual Machine Scale Set (VMSS). - -## EXAMPLES - -### Example 1: Set the storage profile properties for the VMSS -``` -PS C:\> Set-AzureRmVmssStorageProfile -VirtualMachineScaleSet "ContosoVMSS" -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" ` - -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version ` - -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VhdContainer -``` - -This command sets the storage profile properties for the VMSS named ContosoVMSS. - -## PARAMETERS - -### -DataDisk -Specifies the data disk object. - -```yaml -Type: VirtualMachineScaleSetDataDisk[] -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies the blob URI for the user image. -VMSS creates an operating system disk in the same container of the user image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceId -Specifies the image reference ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceOffer -Specifies the type of virtual machine image (VMImage) offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferencePublisher -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceSku -Specifies the VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImageReferenceVersion -Specifies the version of the VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedDisk -Specifies the managed disk. - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskCaching -Specifies the caching mode of the operating system disk. -The acceptable values for this parameter are: - -- ReadOnly -- ReadWrite - -The default value is ReadWrite. -If you change the caching value, the cmdlet will restart the virtual machine. - -This setting affects the consistency and performance of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskCreateOption -Specifies how this cmdlet creates the VMSS virtual machines. - -The acceptable values for this parameter are: - -- Attach : This value is used when you are using a specialized disk to create the VMSS virtual machine. -- FromImage : This value is used when you are using an image to create the VMSS virtual machine. -If you are using a platform image, you will also use the *imageReference* parameter. - -```yaml -Type: DiskCreateOptionTypes -Parameter Sets: (All) -Aliases: -Accepted values: FromImage, Empty, Attach - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskName -Specifies the name of the operating system disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskOsType -Specifies the type of operating system on the disk. -This is only needed for user image scenarios and not for a platform image. - -```yaml -Type: OperatingSystemTypes -Parameter Sets: (All) -Aliases: -Accepted values: Windows, Linux - -Required: False -Position: 8 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdContainer -Specifies the container URLs that are used to store operating system disks for the VMSS. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies the VMSS object. -To obtain the object, use the New-AzureRmVmssConfig object. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet does not generate any output. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMImageOffer](./Get-AzureRmVMImageOffer.md) - -[Get-AzureRmVMImagePublisher](./Get-AzureRmVMImagePublisher.md) - -[Get-AzureRmVMImageSku](./Get-AzureRmVMImageSku.md) - -[New-AzureRmVmssConfig](./New-AzureRmVmssConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssVM.md b/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssVM.md deleted file mode 100644 index 7675c1e461..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Set-AzureRmVmssVM.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 70AA9747-232E-40F2-845C-35A779F51CD2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/set-azurermvmssvm -schema: 2.0.0 ---- - -# Set-AzureRmVmssVM - -## SYNOPSIS -Modifies the state of a VMSS instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-Reimage] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Set-AzureRmVmssVM [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String> [-ReimageAll] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVmssVM** cmdlet modifies the state of a Virtual Machine Scale Set (VMSS) instance. - -## EXAMPLES - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies the ID of the VMSS instance for which this cmdlet modifies state. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Reimage -Indicates that this cmdlet reimages the VMSS instance. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReimageAll -Indicates that the cmdlet reimages all the disks in the VMSS instance. - -```yaml -Type: SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the VMSS instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS instance that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmssVM](./Get-AzureRmVmssVM.md) diff --git a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVM.md deleted file mode 100644 index 419a0cd10e..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVM.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7B3259CD-079D-4E07-8608-F818522EE7CF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvm -schema: 2.0.0 ---- - -# Start-AzureRmVM - -## SYNOPSIS -Starts an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Start-AzureRmVM [-Name] <String> [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Start-AzureRmVM [-Name] <String> [-Id] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmVM** cmdlet starts an Azure virtual machine. - -## EXAMPLES - -### Example 1: Start a virtual machine -``` -PS C:\> Start-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command starts the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmss.md deleted file mode 100644 index c6af621306..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmss.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7F7D1F05-617C-4EC5-8FF5-D816E9148841 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvmss -schema: 2.0.0 ---- - -# Start-AzureRmVmss - -## SYNOPSIS -Starts the VMSS or a set of virtual machines within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmVmss** cmdlet starts all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. -You can use the *InstanceId* parameter to select a set of virtual machines. - -## EXAMPLES - -### Example 1: Start a specific set of virtual machines within the VMSS -``` -PS C:\> Start-AzureRmVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS"-InstanceId "0", "1" -``` - -This command starts a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. - -### Example 2: Start all virtual machines within the VMSS -``` -PS C:\> Start-AzureRmVmss -ResourceGroupName "ContosOrg" -VMScaleSetName "ContosoVMSS" -``` - -This command starts all virtual machines that belong to the VMSS named ContosoVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the instances that cmdlet starts. -For instance: `-InstanceId "0", "3"` - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet starts the virtual machines. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmssRollingOSUpgrade.md b/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmssRollingOSUpgrade.md deleted file mode 100644 index 1407335fc2..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Start-AzureRmVmssRollingOSUpgrade.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/start-azurermvmssrollingosupgrade -schema: 2.0.0 ---- - -# Start-AzureRmVmssRollingOSUpgrade - -## SYNOPSIS -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmVmssRollingOSUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. -Instances which are already running the latest available OS version are not affected. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Start-AzureRmVmssRollingOSUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command starts a rolling upgrade of all vm instances of VM scale set "VMSS001" in resource group "Group001". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVM.md deleted file mode 100644 index 17cac92ece..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVM.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 7C3CF963-6F1A-444C-B90C-C1D24F89204D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvm -schema: 2.0.0 ---- - -# Stop-AzureRmVM - -## SYNOPSIS -Stops an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Stop-AzureRmVM [-Name] <String> [-Force] [-StayProvisioned] [-ResourceGroupName] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Stop-AzureRmVM [-Name] <String> [-Force] [-StayProvisioned] [-Id] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmVM** cmdlet stops an Azure virtual machine. - -## EXAMPLES - -### Example 1: Stop a virtual machine -``` -PS C:\> Stop-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -``` - -This command stops the virtual machine named VirtualMachine07 in ResourceGroup11. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The resource group name. - -```yaml -Type: String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The virtual machine name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine. - -```yaml -Type: String -Parameter Sets: ResourceGroupNameParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StayProvisioned -The cmdlet stops all the virtual machines within the VMSS but does not deallocate them. The account -is charged for the stopped virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Update-AzureRmVM](./Update-AzureRmVM.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmss.md deleted file mode 100644 index 2f88726f2b..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmss.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: AF0DDDD0-B664-4AD8-A569-1363FB2EDB40 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvmss -schema: 2.0.0 ---- - -# Stop-AzureRmVmss - -## SYNOPSIS -Stops the VMSS or a set of virtual machines within the VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Stop-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Stop-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-InstanceId] <String[]>] [-Force] - [-StayProvisioned] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmVmss** cmdlet stops all the virtual machines within the Virtual Machine Scale Set (VMSS) or a set of virtual machines. -You can use the *InstanceId* parameter to select a set of virtual machines. - -## EXAMPLES - -### Example 1: Stop all the virtual machines within the VMSS -``` -PS C:\> Stop-AzureRmVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -``` - -This command stops all virtual machines that belong to the VMSS named ContosoVMSS. - -### Example 2: Stop a specific set of virtual machines within the VMSS -``` -PS C:\> Stop-AzureRmVmss -ResourceGroupName "ContosoGroup" -VMScaleSetName "ContosoVMSS" -InstanceId "3","5" -``` - -This command stops a specific set of virtual machines specified by the instance ID string array that belong to the VMSS named ContosoVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the virtual machine instances that this cmdlet stops. -For instance: `-InstanceId "0", "3"`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StayProvisioned -If specified, the virtual machine will enter stopped state. If not specified, the virtual machine will enter stopped-deallocated state. The user is still charged for VMs in stopped state but not for VMs in stopped-deallocated state. - - -```yaml -Type: SwitchParameter -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS for which this cmdlet stops the virtual machines. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmssRollingUpgrade.md b/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmssRollingUpgrade.md deleted file mode 100644 index 22f28f3245..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Stop-AzureRmVmssRollingUpgrade.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/stop-azurermvmssrollingupgrade -schema: 2.0.0 ---- - -# Stop-AzureRmVmssRollingUpgrade - -## SYNOPSIS -Cancels the current virtual machine scale set rolling upgrade. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Stop-AzureRmVmssRollingUpgrade [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Stop-AzureRmVmssRollingUpgrade [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Cancels the current virtual machine scale set rolling upgrade. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-AzureRmVmssRollingUpgrade -ResourceGroupName "Group001" -VMScaleSetName "VMSS001" -``` - -This command cancels on-going rolling upgrade of VM scale set "VMSS001" in resource group "Group001". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -The name of the VM scale set. - -```yaml -Type: String -Parameter Sets: DefaultParameter -Aliases: Name - -Required: True -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSOperationStatusResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Test-AzureRmVMAEMExtension.md b/azurermps-2.5.0/AzureRm.Compute/Test-AzureRmVMAEMExtension.md deleted file mode 100644 index 1e7fe37c56..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Test-AzureRmVMAEMExtension.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 67AED9B8-AE3D-47E5-813C-9B46E11AE46C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/test-azurermvmaemextension -schema: 2.0.0 ---- - -# Test-AzureRmVMAEMExtension - -## SYNOPSIS -Checks the configuration of the AEM extension. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmVMAEMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-OSType] <String>] - [[-WaitTimeInMinutes] <Int32>] [-SkipStorageCheck] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmVMAEMExtension** cmdlet checks the configuration of the Azure Enhanced Monitoring (AEM) extension. -The AEM extension collects the performance data. -This cmdlet checks whether performance data is available. - -## EXAMPLES - -### Example 1: Check the configuration of the AEM extension -``` -PS C:\> Test-AzureRmVMAEMExtension -ResourceGroupName "ResourceGroup11" -VMName "contoso-server" -``` - -This command checks the configuration of the AEM extension for the virtual machine named contoso-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 -``` - -### -OSType -Specifies the type of the operating system of the operating system disk. -If the operating system disk does not have a type, you must specify this parameter. -The acceptable values for this parameter are: Windows and Linux. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the virtual machine that this cmdlet checks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipStorageCheck -Indicates that this cmdlet skips the check of storage configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine. -This cmdlet tests the AEM extension for the virtual machine that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WaitTimeInMinutes -Specifies a time-out period, in minutes, for the storage configuration check. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Extension.AEM.AEMTestResult - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVMAEMExtension](./Get-AzureRmVMAEMExtension.md) - -[Remove-AzureRmVMAEMExtension](./Remove-AzureRmVMAEMExtension.md) - -[Set-AzureRmVMAEMExtension](./Set-AzureRmVMAEMExtension.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmAvailabilitySet.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmAvailabilitySet.md deleted file mode 100644 index 554707d0c6..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmAvailabilitySet.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermavailabilityset -schema: 2.0.0 ---- - -# Update-AzureRmAvailabilitySet - -## SYNOPSIS -Updates an availability set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SkuParameterSet -``` -Update-AzureRmAvailabilitySet [-AvailabilitySet] <PSAvailabilitySet> [-Sku] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagedParamterSet -``` -Update-AzureRmAvailabilitySet [-AvailabilitySet] <PSAvailabilitySet> [-Managed] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmAvailabilitySet** cmdlet updates an availability set. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAvailabilitySet -ResourceGroupName 'ResourceGroup01' -Name 'AvSet01' | Update-AzureRmAvailabilitySet -Managed; -``` - -This command updates the availability set named 'AvSet01' in the resource group named 'ResourceGroup01' to a managed availability set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvailabilitySet -Specifies the availability set object to be updated. - -```yaml -Type: PSAvailabilitySet -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, 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 -``` - -### -Managed -Managed Availability Set - -```yaml -Type: SwitchParameter -Parameter Sets: ManagedParamterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sku -The Name of Sku - -```yaml -Type: String -Parameter Sets: SkuParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAvailabilitySet - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmContainerService.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmContainerService.md deleted file mode 100644 index a49cfc1493..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmContainerService.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 43D01A97-75B9-46CE-B007-26FE6A97C31C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermcontainerservice -schema: 2.0.0 ---- - -# Update-AzureRmContainerService - -## SYNOPSIS -Updates the state of a container service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> - [-ContainerService] <PSContainerService> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmContainerService** cmdlet updates the state of a container service to match a local instance of the service. - -## EXAMPLES - -### Example 1: Update a container service -``` -PS C:\> Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" | Remove-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17" -Count 2 | Update-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" -``` - -This command gets the container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. -The command passes that object to the Remove-AzureRmContainerServiceAgentPoolProfile cmdlet by using the pipeline operator. - -**Remove-AzureRmContainerServiceAgentPoolProfile** removes the profile named AgentPool01. -The command passes the result to the Add-AzureRmContainerServiceAgentPoolProfile cmdlet. - -**Add-AzureRmContainerServiceAgentPoolProfile** adds a profile that has the name AgentPool01, and has the specified properties. -The command passes the result to the current cmdlet. - -The current cmdlet updates the container service to reflect the changes that were made in this command. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContainerService -Specifies a local **ContainerService** object that contains changes. - -```yaml -Type: PSContainerService -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 -``` - -### -Name -Specifies the name of the container service that this cmdlet updates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of the container service that this cmdlet updates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ContainerService -Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService - -## NOTES - -## RELATED LINKS - -[Add-AzureRmContainerServiceAgentPoolProfile](./Add-AzureRmContainerServiceAgentPoolProfile.md) - -[Get-AzureRmContainerService](./Get-AzureRmContainerService.md) - -[New-AzureRmContainerService](./New-AzureRmContainerService.md) - -[Remove-AzureRmContainerService](./Remove-AzureRmContainerService.md) - -[Remove-AzureRmContainerServiceAgentPoolProfile](./Remove-AzureRmContainerServiceAgentPoolProfile.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmDisk.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmDisk.md deleted file mode 100644 index c82aba5a00..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmDisk.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermdisk -schema: 2.0.0 ---- - -# Update-AzureRmDisk - -## SYNOPSIS -Updates a disk. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-DiskUpdate] <PSDiskUpdate> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FriendMethod -``` -Update-AzureRmDisk [-ResourceGroupName] <String> [-DiskName] <String> [-Disk] <PSDisk> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmDisk** cmdlet updates a disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig; -``` - -The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the disk update object. -The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmDiskUpdateConfig -DiskSizeGB 10 | Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -``` - -This command updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -### Example 3 -``` -PS C:\> $disk = Get-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'; -PS C:\> $disk.DiskSizeGB = 10; -PS C:\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $disk; -``` - -These commands also update an existing disk with name 'Disk01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies a local disk object. - -```yaml -Type: PSDisk -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of a disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DiskUpdate -Specifies a local disk update object. - -```yaml -Type: PSDiskUpdate -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Automation.Models.PSDiskUpdate -Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSDisk - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmImage.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmImage.md deleted file mode 100644 index ba067012ab..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmImage.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermimage -schema: 2.0.0 ---- - -# Update-AzureRmImage - -## SYNOPSIS -Updates an image. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmImage [-ResourceGroupName] <String> [-ImageName] <String> [-Image] <PSImage> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmImage** cmdlet updates an image. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' | Remove-AzureRmImageDataDisk -Lun 1 | Update-AzureRmImage; -``` - -This command removes the data disk of logical unit number 1 from the existing image 'Image01' in the resource group 'ResourceGroup01'. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Image -Specifies a local image object. - -```yaml -Type: PSImage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ImageName -Specifies the name of an image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Automation.Models.PSImage - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmSnapshot.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmSnapshot.md deleted file mode 100644 index 6aab7352ca..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmSnapshot.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermsnapshot -schema: 2.0.0 ---- - -# Update-AzureRmSnapshot - -## SYNOPSIS -Updates a snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> - [-SnapshotUpdate] <PSSnapshotUpdate> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### FriendMethod -``` -Update-AzureRmSnapshot [-ResourceGroupName] <String> [-SnapshotName] <String> [-Snapshot] <PSSnapshot> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmSnapshot** cmdlet updates a snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true; -PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/; -PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123'; -PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456; -PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456'; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId; -PS C:\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig; -``` - -The first command creates a local empty snapshot update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and enables encryption settings. -The second and third commands set the disk encryption key and key encryption key settings for the snapshot update object. -The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'. - -### Example 2 -``` -PS C:\> New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -``` - -This command updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. - -### Example 3 -``` -PS C:\> $snapshot = Get-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01'; -PS C:\> $snapshot.DiskSizeGB = 10; -PS C:\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshot; -``` - -These commands also update an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Snapshot -Specifies a local snapshot object. - -```yaml -Type: PSSnapshot -Parameter Sets: FriendMethod -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of a snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotUpdate -Specifies a local snapshot update object. - -```yaml -Type: PSSnapshotUpdate -Parameter Sets: DefaultParameter -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate -Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshot - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVM.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVM.md deleted file mode 100644 index 5b37923d14..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVM.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 38917534-49C6-47EA-B815-240F794EE655 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvm -schema: 2.0.0 ---- - -# Update-AzureRmVM - -## SYNOPSIS -Updates the state of an Azure virtual machine. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupNameParameterSetName (Default) -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] - [-OsDiskWriteAccelerator <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AssignIdentityParameterSet -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] [-AssignIdentity] - [-OsDiskWriteAccelerator <Boolean>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -Update-AzureRmVM [-ResourceGroupName] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] - -IdentityType <ResourceIdentityType> [-IdentityId <String[]>] [-OsDiskWriteAccelerator <Boolean>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSetName -``` -Update-AzureRmVM [-Id] <String> -VM <PSVirtualMachine> [-Tag <Hashtable>] [-OsDiskWriteAccelerator <Boolean>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmVM** cmdlet updates the state of an Azure virtual machine to the state of a virtual machine object. - -## EXAMPLES - -### Example 1: Update a virtual machine -``` -PS C:\> Update-AzureRmVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine -``` - -This command updates the virtual machine, $VirtualMachine, in ResourceGroup11. -The command updates it by using the virtual machine object stored in the $VirtualMachine variable. -To obtain a virtual machine object, use the **Get-AzureRmVM** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Specify the system assigned identity for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: AssignIdentityParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 Resource ID of the virtual machine. - -```yaml -Type: String -Parameter Sets: IdParameterSetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - -```yaml -Type: ResourceIdentityType -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -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 virtual machine. - -```yaml -Type: String -Parameter Sets: ResourceGroupNameParameterSetName, AssignIdentityParameterSet, ExplicitIdentityParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Specifies the resources and resource groups can be tagged with a set of name-value pairs. -Adding tags to resources enables you to group resources together across resource groups and to create your own views. -Each resource or resource group can have a maximum of 15 tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies a local virtual machine object. -To obtain a virtual machine object, use the Get-AzureRmVM cmdlet. -This virtual machine object contains the updated state for the virtual machine. - -```yaml -Type: PSVirtualMachine -Parameter Sets: (All) -Aliases: VMProfile - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualMachine -Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVM](./Get-AzureRmVM.md) - -[New-AzureRmVM](./New-AzureRmVM.md) - -[Remove-AzureRmVM](./Remove-AzureRmVM.md) - -[Restart-AzureRmVM](./Restart-AzureRmVM.md) - -[Start-AzureRmVM](./Start-AzureRmVM.md) - -[Stop-AzureRmVM](./Stop-AzureRmVM.md) - -[New-AzureRmVMConfig](./New-AzureRmVMConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmss.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmss.md deleted file mode 100644 index 0802075781..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmss.md +++ /dev/null @@ -1,801 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: 9EE192A5-4E3F-41ED-A539-8E0A5D5EA4C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvmss -schema: 2.0.0 ---- - -# Update-AzureRmVmss - -## SYNOPSIS -Updates the state of a VMSS. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameter (Default) -``` -Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-ImageReferenceSku <String>] - [-ManagedDiskStorageAccountType <StorageAccountTypes>] [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] - [-BootDiagnosticsEnabled <Boolean>] [-Overprovision <Boolean>] [-MaxBatchInstancePercent <Int32>] - [-TimeZone <String>] [-BootDiagnosticsStorageUri <String>] [-AutomaticOSUpgrade <Boolean>] - [-SinglePlacementGroup <Boolean>] [-CustomData <String>] [-UpgradePolicyMode <UpgradeMode>] - [-ImageReferenceId <String>] [-DisablePasswordAuthentication <Boolean>] [-Tag <Hashtable>] - [-PlanName <String>] [-MaxUnhealthyUpgradedInstancePercent <Int32>] [-ImageReferencePublisher <String>] - [-PlanProduct <String>] [-VhdContainer <String[]>] [-ImageUri <String>] [-SkuTier <String>] - [-EnableAutomaticUpdate <Boolean>] [-LicenseType <String>] [-SkuName <String>] [-PlanPromotionCode <String>] - [-MaxUnhealthyInstancePercent <Int32>] [-SkuCapacity <Int32>] [-OsDiskWriteAccelerator <Boolean>] - [-ImageReferenceOffer <String>] [-PauseTimeBetweenBatches <String>] [-OsDiskCaching <CachingTypes>] - [-ImageReferenceVersion <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ExplicitIdentityParameterSet -``` -Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> - [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-ImageReferenceSku <String>] [-IdentityId <String[]>] - [-ManagedDiskStorageAccountType <StorageAccountTypes>] [-PlanPublisher <String>] [-ProvisionVMAgent <Boolean>] - [-BootDiagnosticsEnabled <Boolean>] [-Overprovision <Boolean>] [-MaxBatchInstancePercent <Int32>] - [-TimeZone <String>] [-BootDiagnosticsStorageUri <String>] [-AutomaticOSUpgrade <Boolean>] - [-SinglePlacementGroup <Boolean>] [-CustomData <String>] [-UpgradePolicyMode <UpgradeMode>] - [-ImageReferenceId <String>] [-DisablePasswordAuthentication <Boolean>] [-Tag <Hashtable>] - [-PlanName <String>] [-MaxUnhealthyUpgradedInstancePercent <Int32>] [-ImageReferencePublisher <String>] - [-PlanProduct <String>] [-VhdContainer <String[]>] [-ImageUri <String>] [-SkuTier <String>] - [-EnableAutomaticUpdate <Boolean>] [-LicenseType <String>] -IdentityType <ResourceIdentityType> - [-SkuName <String>] [-PlanPromotionCode <String>] [-MaxUnhealthyInstancePercent <Int32>] - [-SkuCapacity <Int32>] [-OsDiskWriteAccelerator <Boolean>] [-ImageReferenceOffer <String>] - [-PauseTimeBetweenBatches <String>] [-OsDiskCaching <CachingTypes>] [-ImageReferenceVersion <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmVmss** cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object. - -## EXAMPLES - -### Example 1: Update the state of a VMSS to the state of a local VMSS object. -``` -PS C:\> Update-AzureRmVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS -``` - -This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object, $LocalVMSS. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticOSUpgrade -Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnosticsEnabled -Whether boot diagnostics should be enabled on the virtual machine scale set. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDiagnosticsStorageUri -URI of the storage account to use for placing the console output and screenshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomData -Specifies a base-64 encoded string of custom data. -This is decoded to a binary array that is saved as a file on the virtual machine. -The maximum length of the binary array is 65535 bytes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisablePasswordAuthentication -Indicates that this cmdlet disables password authentication for Linux OS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAutomaticUpdate -Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityId -Specifies the list of user identities associated with the virtual machine scale set. -The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}' - -```yaml -Type: String[] -Parameter Sets: ExplicitIdentityParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Specifies the type of identity used for the virtual machine scale set. -The type 'SystemAssignedUserAssigned' includes both an implicitly created identity and a set of user assigned identities. -The type 'None' will remove any identities from the virtual machine scale set. -The acceptable values for this parameter are: - -- SystemAssigned -- UserAssigned -- SystemAssignedUserAssigned -- None - -```yaml -Type: ResourceIdentityType -Parameter Sets: ExplicitIdentityParameterSet -Aliases: -Accepted values: SystemAssigned, UserAssigned, SystemAssignedUserAssigned, None - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceId -Specifies the image reference ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceOffer -Specifies the type of virtual machine image (VMImage) offer. -To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferencePublisher -Specifies the name of a publisher of a VMImage. -To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceSku -Specifies the VMImage SKU. -To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceVersion -Specifies the version of the VMImage. -To use the latest version, specify a value of latest instead of a particular version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageUri -Specifies the blob URI for the user image. -VMSS creates an operating system disk in the same container of the user image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Specify the license type, which is for bringing your own license scenario. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedDiskStorageAccountType -Specifies the storage account type for managed disk. -The acceptable values for this parameter are: - -- StandardLRS -- PremiumLRS - -```yaml -Type: StorageAccountTypes -Parameter Sets: (All) -Aliases: -Accepted values: StandardLRS, PremiumLRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBatchInstancePercent -The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. -As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxUnhealthyInstancePercent -The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. -This constraint will be checked prior to starting any batch. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxUnhealthyUpgradedInstancePercent -The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. -This check will happen after each batch is upgraded. -If this percentage is ever exceeded, the rolling update aborts. -If the value is not specified, it is set to 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskCaching -Specifies the caching mode of the operating system disk. -The acceptable values for this parameter are: - -- None -- ReadOnly -- ReadWrite - -The default value is ReadWrite. -If you change the caching value, the cmdlet will restart the virtual machine. - -This setting affects the consistency and performance of the disk. - -```yaml -Type: CachingTypes -Parameter Sets: (All) -Aliases: -Accepted values: None, ReadOnly, ReadWrite - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsDiskWriteAccelerator -Specifies whether WriteAccelerator should be enabled or disabled on the OS disk. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overprovision -Indicates whether the cmdlet overprovisions the VMSS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PauseTimeBetweenBatches -The wait time between completing the update for all virtual machines in one batch and starting the next batch. -The time duration should be specified in ISO 8601 format. -The default value is 0 seconds (PT0S). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanName -Specifies the plan name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanProduct -Specifies the plan product. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanPromotionCode -Specifies the plan promotion code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PlanPublisher -Specifies the plan publisher. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProvisionVMAgent -Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group the VMSS belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SinglePlacementGroup -Specifies the single placement group. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -Specifies the number of instances in the VMSS. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -Specifies the size of all the instances of VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -Specifies the tier of VMSS. -The acceptable values for this parameter are: - -- Standard -- Basic - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -Specifies the time zone for Windows OS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpgradePolicyMode -Specified the mode of an upgrade to virtual machines in the scale set. -The acceptable values for this parameter are: - -- Automatic -- Manual -- Rolling - -```yaml -Type: UpgradeMode -Parameter Sets: (All) -Aliases: -Accepted values: Automatic, Manual, Rolling - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdContainer -Specifies the container URLs that are used to store operating system disks for the VMSS. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSet -Specifies a local VMSS object. -To obtain a VMSS object, use the Get-AzureRmVmss cmdlet. -This virtual machine object contains the updated state for the VMSS. - -```yaml -Type: PSVirtualMachineScaleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### VirtualMachineScaleSet -Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVmss](./Get-AzureRmVmss.md) - -[New-AzureRmVmss](./New-AzureRmVmss.md) - -[Remove-AzureRmVmss](./Remove-AzureRmVmss.md) - -[Restart-AzureRmVmss](./Restart-AzureRmVmss.md) - -[Set-AzureRmVmss](./Set-AzureRmVmss.md) - -[Start-AzureRmVmss](./Start-AzureRmVmss.md) - -[Stop-AzureRmVmss](./Stop-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmssInstance.md b/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmssInstance.md deleted file mode 100644 index 798040e18f..0000000000 --- a/azurermps-2.5.0/AzureRm.Compute/Update-AzureRmVmssInstance.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Compute.dll-Help.xml -Module Name: AzureRM.Compute -ms.assetid: E8C9D68E-7C68-43D0-B348-72E9713CB99F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.compute/update-azurermvmssinstance -schema: 2.0.0 ---- - -# Update-AzureRmVmssInstance - -## SYNOPSIS -Starts a manual upgrade of the VMSS instance. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmVmssInstance [-ResourceGroupName] <String> [-VMScaleSetName] <String> [-InstanceId] <String[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Update-AzureRmVmssInstance cmdlet starts a manual upgrade of the specified Virtual Machine Scale Set (VMSS) instance. -This is used when the upgrade policy on the VMSS Scale Set is set to manual. - -## EXAMPLES - -### Example 1: Start an upgrade of the VMSS instance -``` -PS C:\> Update-AzureRmVmssInstance -ResourceGroupName "Group011" -VMScaleSetName "VMScaleSet001" -InstanceId "0" -``` - -This command starts an upgrade of the VMSS named VMScaleSet001 that has the instance ID of 0. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background and return a Job to track progress. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceId -Specifies, as a string array, the ID or IDs of the instance to upgrade. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group of the VMSS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMScaleSetName -Specifies the name of the VMSS instance that this cmdlet upgrades. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 2 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### -This cmdlet does not generate any output. - -## NOTES - -## RELATED LINKS - -[Update-AzureRmVmss](./Update-AzureRmVmss.md) - - diff --git a/azurermps-2.5.0/AzureRm.Dns/Add-AzureRmDnsRecordConfig.md b/azurermps-2.5.0/AzureRm.Dns/Add-AzureRmDnsRecordConfig.md deleted file mode 100644 index b5491e4062..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Add-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,396 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: CD119EBE-E1A4-4E9D-B3BA-FDAF89BF0DDB -online version: -schema: 2.0.0 ---- - -# Add-AzureRmDnsRecordConfig - -## SYNOPSIS -Adds a DNS record to a local record set object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> [<CommonParameters>] -``` - -### AAAA -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> [<CommonParameters>] -``` - -### NS -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> [<CommonParameters>] -``` - -### MX -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> - [<CommonParameters>] -``` - -### PTR -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> [<CommonParameters>] -``` - -### TXT -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> [<CommonParameters>] -``` - -### SRV -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> - -Weight <UInt16> [<CommonParameters>] -``` - -### CNAME -``` -Add-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmDnsRecordConfig** cmdlet adds a Domain Name System (DNS) record to a **RecordSet** object. -The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. - -SOA records are created when a DNS zone is created, and are removed when the DNS zone is deleted. -You cannot add or remove SOA records, but you can edit them. - -You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. - -## EXAMPLES - -### Example 1: Add an A record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet -``` - -This example adds an A record to an existing record set. - -### Example 2: Add an AAAA record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet -``` - -This example adds an AAAA record to an existing record set. - -### Example 3: Add a CNAME record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet -``` - -This example adds a CNAME record to an existing record set. -Because a CNAME record set can contain at most one record, it must initially be an empty record set, or existing records must be removed using Remove-AzureRmDnsRecordConfig. - -### Example 4: Add an MX record to a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet -``` - -This example adds an MX record to an existing record set. -The record name "@" indicates a record set at the zone apex. - -### Example 5: Add an NS record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# You can also pipe the above sequence: - -PS C:\> Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzureRmDnsRecordSet -``` - -This example adds an NS record to an existing record set. - -### Example 6: Add a PTR record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa -PS C:\> Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet -``` - -This example adds a PTR record to an existing record set. - -### Example 7: Add an SRV record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet -``` - -This example adds an SRV record to an existing record set. - -### Example 8: Add a TXT record to a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet -``` - -This example adds a TXT record to an existing record set. - -## PARAMETERS - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: String -Parameter Sets: CNAME -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: String -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: String -Parameter Sets: AAAA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server name for a name server (NS) record. - -```yaml -Type: String -Parameter Sets: NS -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: UInt16 -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer resource (PTR) record. - -```yaml -Type: String -Parameter Sets: PTR -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object to edit. - -```yaml -Type: DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: String -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: String -Parameter Sets: TXT -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -You can pipe a **RecordSet** object to this cmdlet. -This is an offline representation of the **RecordSet**, and changes to it do not change DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -This cmdlet returns the modified **RecordSet** object. -In addition, the object passed in is modified directly. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordConfig](./Remove-AzureRmDnsRecordConfig.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/AzureRM.DNS.md b/azurermps-2.5.0/AzureRm.Dns/AzureRM.DNS.md deleted file mode 100644 index b36edfb475..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/AzureRM.DNS.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -Module Name: AzureRM.DNS -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: {{Please enter FwLink manually}} -Help Version: {{Please enter version of help manually (X.X.X.X) format}} -Locale: en-US ---- - -# AzureRM.DNS Module -## Description -This topic displays help topics for the Azure DNS Cmdlets. - -## AzureRM.DNS Cmdlets -### [Add-AzureRmDnsRecordConfig](Add-AzureRmDnsRecordConfig.md) -Adds a DNS record to a local record set object. - -### [Get-AzureRmDnsRecordSet](Get-AzureRmDnsRecordSet.md) -Gets a DNS record set. - -### [Get-AzureRmDnsZone](Get-AzureRmDnsZone.md) -Gets a DNS zone. - -### [New-AzureRmDnsRecordConfig](New-AzureRmDnsRecordConfig.md) -Creates a new DNS record local object. - -### [New-AzureRmDnsRecordSet](New-AzureRmDnsRecordSet.md) -Creates a DNS record set. - -### [New-AzureRmDnsZone](New-AzureRmDnsZone.md) -Creates a new DNS zone. - -### [Remove-AzureRmDnsRecordConfig](Remove-AzureRmDnsRecordConfig.md) -Removes a DNS record from a local record set object. - -### [Remove-AzureRmDnsRecordSet](Remove-AzureRmDnsRecordSet.md) -Deletes a record set. - -### [Remove-AzureRmDnsZone](Remove-AzureRmDnsZone.md) -Removes a DNS zone from a resource group. - -### [Set-AzureRmDnsRecordSet](Set-AzureRmDnsRecordSet.md) -Updates a DNS record set. - -### [Set-AzureRmDnsZone](Set-AzureRmDnsZone.md) -Updates the properties of a DNS zone. - diff --git a/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsRecordSet.md b/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsRecordSet.md deleted file mode 100644 index 7aca5cf5cf..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: 40179CF3-7896-4C45-BC18-4CB653B245B6 -online version: -schema: 2.0.0 ---- - -# Get-AzureRmDnsRecordSet - -## SYNOPSIS -Gets a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Get-AzureRmDnsRecordSet [-Name <String>] -ZoneName <String> -ResourceGroupName <String> - [-RecordType <RecordType>] [<CommonParameters>] -``` - -### Object -``` -Get-AzureRmDnsRecordSet [-Name <String>] -Zone <DnsZone> [-RecordType <RecordType>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDnsRecordSet** cmdlet gets the Domain Name System (DNS) record set with the specified name and type, in the specified zone. - -If you do not specify the *Name* or *RecordType* parameters, this cmdlet returns all record sets of the specified type in the zone. -If you specify the *RecordType* parameter but not the *Name* parameter, this cmdlet returns all record sets of the specified record type. - -You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone and resource group by name. - -## EXAMPLES - -### Example 1: Get record sets with a specified name and type -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A -``` - -This command gets the record set of record type A named www in the specified resource group and zone, and then stores it in the $RecordSet variable. -Because the *Name* and *RecordType* parameters are specified, only one **RecordSet** object is returned. - -### Example 2: Get record sets of a specified type -``` -PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A -``` - -This command gets an array of all record sets of record type A in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. - -### Example 3: Get all record sets in a zone -``` -PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -``` - -This command gets an array of all record sets in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable. - -### Example 4: Get all record sets in a zone, using a DnsZone object -``` -PS C:\> $Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $RecordSets = Get-AzureRmDnsRecordSet -Zone $Zone -``` - -This example is equivalent to Example 3 above. -This time, the zone is specified using a zone object. - -## PARAMETERS - -### -Name -Specifies the name of the **RecordSet** to get. -If you do not specify the *Name* parameter, all record sets of the specified type are returned. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record that this cmdlet gets. - -Valid values are: - -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SOA -- SRV -- TXT - -If you do not specify the *RecordType* parameter, you must also omit the *Name* parameter. -This cmdlet then returns all record sets in the zone (of all names and types). - -```yaml -Type: RecordType -Parameter Sets: (All) -Aliases: -Accepted values: A, AAAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone. -The zone name must also be specified, using the *ZoneName* parameter. - -Alternatively, you can specify the zone and resource group by passing in a **DnsZone** object using the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone that contains the record set that this cmdlet gets. -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the DNS zone that contains the record set to get. -The resource group containing the zone must also be specified, using the *ResourceGroupName* parameter. - -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -You can pipe a **DnsZone** object to this cmdlet. -The **DnsZone** object represents the zone in which to look for the **RecordSet** object. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -This cmdlet returns one or more objects that represents the record sets that are found. -There will be at most one **RecordSet** returned if the *Name* and *RecordType* parameters are specified, otherwise multiple **RecordSet** objects are returned as an array. - -## NOTES - -## RELATED LINKS - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) - - diff --git a/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsZone.md b/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsZone.md deleted file mode 100644 index eac618136c..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Get-AzureRmDnsZone.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63 -online version: -schema: 2.0.0 ---- - -# Get-AzureRmDnsZone - -## SYNOPSIS -Gets a DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Get-AzureRmDnsZone [<CommonParameters>] -``` - -### ResourceGroup -``` -Get-AzureRmDnsZone [-Name <String>] -ResourceGroupName <String> [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDnsZone** cmdlet gets a Domain Name System (DNS) zone from the specified resource group. -If you specify the *Name* parameter, a single **DnsZone** object is returned. -If you do not specify the *Name* parameter, an array containing all of the zones in the specified resource group is returned. -You can use the **DnsZone** object to update the zone, for example you can add **RecordSet** objects to it. - -## EXAMPLES - -### Example 1: Get a zone -``` -PS C:\> $Zone = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -``` - -This example gets the DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. - -### Example 2: Get all of the zones in a resource group -``` -PS C:\> $Zones = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" -``` - -This example gets all of the DNS zones in the specified resource group, and then stores it in the $Zones variable. - -### Example 3: Get all of the zones in a subscription -``` -PS C:\> $Zones = Get-AzureRmDnsZone -``` - -This example gets all of the DNS zones in the current Azure subscription, and then stores them in the $Zones variable. - -## PARAMETERS - -### -Name -Specifies the name of the DNS zone to get. - -If you do not specify a value for the *Name* parameter, this cmdlet gets all DNS zones in the specified resource group. -If you also omit the *ResourceGroupName* parameter, this cmdlet gets all DNS zones in the current Azure subscription. - -```yaml -Type: String -Parameter Sets: ResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the DNS zone to get. - -If you do not specify the *ResourceGroupName*, then you must also omit the *Name* parameter. -In this case, this cmdlet gets all DNS zones in the current Azure subscription. - -```yaml -Type: String -Parameter Sets: ResourceGroup -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not allow you to pipe input. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -This cmdlet returns an object that represents the DNS zone. -If the zone name is not specified, an array of zone objects is returned. - -## NOTES - -## RELATED LINKS - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) - -[Set-AzureRmDnsZone](./Set-AzureRmDnsZone.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordConfig.md b/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordConfig.md deleted file mode 100644 index 1932c75498..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: AD97BCAF-69BA-4C16-8B57-AB243D796B71 -online version: -schema: 2.0.0 ---- - -# New-AzureRmDnsRecordConfig - -## SYNOPSIS -Creates a new DNS record local object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -New-AzureRmDnsRecordConfig -Ipv4Address <String> [<CommonParameters>] -``` - -### Aaaa -``` -New-AzureRmDnsRecordConfig -Ipv6Address <String> [<CommonParameters>] -``` - -### Ns -``` -New-AzureRmDnsRecordConfig -Nsdname <String> [<CommonParameters>] -``` - -### Mx -``` -New-AzureRmDnsRecordConfig -Exchange <String> -Preference <UInt16> [<CommonParameters>] -``` - -### Ptr -``` -New-AzureRmDnsRecordConfig -Ptrdname <String> [<CommonParameters>] -``` - -### Txt -``` -New-AzureRmDnsRecordConfig -Value <String> [<CommonParameters>] -``` - -### Srv -``` -New-AzureRmDnsRecordConfig -Priority <UInt16> -Target <String> -Port <UInt16> -Weight <UInt16> - [<CommonParameters>] -``` - -### CName -``` -New-AzureRmDnsRecordConfig -Cname <String> [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsRecordConfig** cmdlet creates a local **DnsRecord** object. -An array of these objects is passed to the New-AzureRmDnsRecordSet cmdlet using the *DnsRecords* parameter to specify the records to create in the record set. - -## EXAMPLES - -### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records - -# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: - -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) - -# To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, -# then call New-AzureRmDnsRecordSet, as follows: - -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type MX and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named ns1 in the zone myzone.com. -The record set is of type NS and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records -``` - -This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. -The record set is of type PTR and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. -The record set is of type SRV and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record, pointing to the IP address 2001.2.3.4. - -The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named text in the zone myzone.com. -The record set is of type TXT and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -## PARAMETERS - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: String -Parameter Sets: CName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: String -Parameter Sets: Mx -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: String -Parameter Sets: Aaaa -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server name for a name server (NS) record. - -```yaml -Type: String -Parameter Sets: Ns -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: UInt16 -Parameter Sets: Mx -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer resource (PTR) record. - -```yaml -Type: String -Parameter Sets: Ptr -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: String -Parameter Sets: Srv -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: String -Parameter Sets: Txt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: Srv -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordBase - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordConfig](./Remove-AzureRmDnsRecordConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordSet.md b/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordSet.md deleted file mode 100644 index 4a468a28e5..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,448 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: 45DF71E0-77E1-4D20-AD09-2C06680F659F -online version: -schema: 2.0.0 ---- - -# New-AzureRmDnsRecordSet - -## SYNOPSIS -Creates a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -New-AzureRmDnsRecordSet -Name <String> -ZoneName <String> -ResourceGroupName <String> -Ttl <UInt32> - -RecordType <RecordType> [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] [-Force] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -New-AzureRmDnsRecordSet -Name <String> -Zone <DnsZone> -Ttl <UInt32> -RecordType <RecordType> - [-Metadata <Hashtable>] [-DnsRecords <DnsRecordBase[]>] [-Overwrite] [-Force] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsRecordSet** cmdlet creates a new Domain Name System (DNS) record set with the specified name and type in the specified zone. -A **RecordSet** object is a set of DNS records with the same name and type. -Note that the name is relative to the zone and not the fully qualified name. - -The *DnsRecords* parameter specifies the records in the record set. -This parameter takes an array of DNS records, constructed using New-AzureRmDnsRecordConfig. - -You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, or you can pass a **DnsZone** object as the *Zone* parameter, or alternatively you can specify the zone by name. - -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. - -If a matching **RecordSet** already exists (same name and record type), you must specify the *Overwrite* parameter, otherwise the cmdlet will not create a new **RecordSet** . - -## EXAMPLES - -### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records - -# When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: - -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) - -# To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, -# then call New-AzureRmDnsRecordSet, as follows: - -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This example creates a **RecordSet** named www in the zone myzone.com. -The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type MX and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named ns1 in the zone myzone.com. -The record set is of type NS and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records -``` - -This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. -The record set is of type PTR and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. -The record set is of type SRV and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record, pointing to the IP address 2001.2.3.4. - -The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named text in the zone myzone.com. -The record set is of type TXT and has a TTL of 1 hour (3600 seconds). -It contains a single DNS record. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 9: Create a RecordSet at the zone apex -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** at the apex (or root) of the zone myzone.com. -To do this, the record set name is specified as "@" (including the double-quotes). - -You cannot create CNAME records at the apex of a zone. -This is a constraint of the DNS standards; it is not a limitation of Azure DNS. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 10: Create a wildcard Record Set -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records -``` - -This command creates a **RecordSet** named * in the zone myzone.com. -This is a wildcard record set. - -To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. - -### Example 11: Create an empty record set -``` -PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords @() -``` - -This command creates a **RecordSet** named www in the zone myzone.com. -The record set is of type A and has a TTL of 1 hour (3600 seconds). -This is an empty record set, which acts as a placeholder to which you can later add records. - -### Example 12: Create a record set and suppress all confirmation -``` -PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite -``` - -This command creates a **RecordSet**. -The *Overwrite* parameter ensures that this record set overwrites any pre-existing record set with the same name and type (existing records in that record set are lost). -The *Confirm* parameter with a value of $False suppresses the confirmation prompt. - -## PARAMETERS - -### -DnsRecords -Specifies the array of DNS records to include in the record set. -You can use the New-AzureRmDnsRecordConfig cmdlet to create DNS record objects. -See the examples for more information. - -```yaml -Type: DnsRecordBase[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -This parameter is deprecated for this cmdlet. -It will be removed in a future release. - -To control whether this cmdlet prompts you for comfirmation, use the *Confirm* parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metadata -Specifies an array of metadata to associate with the RecordSet. -Metadata is specified using name-value pairs that are represented as hash tables, for example @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"}). - -```yaml -Type: Hashtable -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 **RecordSet** to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Indicates that this cmdlet overwrites the specified **RecordSet** if it already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record to create. - -Valid values are: - -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT - -SOA records are created automatically when the zone is created and cannot be created manually. - -```yaml -Type: RecordType -Parameter Sets: (All) -Aliases: -Accepted values: A, AAAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone. -You must also specify the *ZoneName* parameter to specify the zone name. - -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ttl -Specifies the Time to Live (TTL) for the DNS RecordSet. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DnsZone in which to create the **RecordSet**. -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which to create the **RecordSet**. -You must also specify the resource group containing the zone using the *ResourceGroupName* parameter. - -Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -You can pipe a DnsZone object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -This cmdlet returns a **RecordSet** object. - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordConfig](./New-AzureRmDnsRecordConfig.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsZone.md b/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsZone.md deleted file mode 100644 index 342e877e30..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/New-AzureRmDnsZone.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: B78F3E8B-C7D2-458C-AB23-06F584FE97E0 -online version: -schema: 2.0.0 ---- - -# New-AzureRmDnsZone - -## SYNOPSIS -Creates a new DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDnsZone** cmdlet creates a new Domain Name System (DNS) zone in the specified -resource group. You must specify a unique DNS zone name for the *Name* parameter or the cmdlet will -return an error. After the zone is created, use the New-AzureRmDnsRecordSet cmdlet to create record -sets in the zone. - -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control -whether the cmdlet prompts you for confirmation. - -## EXAMPLES - -### Example 1: Create a DNS zone -``` -PS C:\>$Zone = New-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -``` - -This command creates a new DNS zone named myzone.com in the specified resource group, and then -stores it in the $Zone variable. - -## PARAMETERS - -### -Name -Specifies the name of the DNS zone to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group in which to create the zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -You cannot pipe input to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone - -This cmdlet returns a Microsoft.Azure.Commands.Dns.DnsZone object that represents the new DNS zone. - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordConfig.md b/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordConfig.md deleted file mode 100644 index a01c0e5461..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordConfig.md +++ /dev/null @@ -1,410 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: D1A2326C-CD41-45A6-B37A-FC6176193B01 -online version: -schema: 2.0.0 ---- - -# Remove-AzureRmDnsRecordConfig - -## SYNOPSIS -Removes a DNS record from a local record set object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### A -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv4Address <String> [<CommonParameters>] -``` - -### AAAA -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ipv6Address <String> [<CommonParameters>] -``` - -### NS -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Nsdname <String> [<CommonParameters>] -``` - -### MX -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Exchange <String> -Preference <UInt16> - [<CommonParameters>] -``` - -### PTR -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Ptrdname <String> [<CommonParameters>] -``` - -### TXT -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Value <String> [<CommonParameters>] -``` - -### SRV -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Priority <UInt16> -Target <String> -Port <UInt16> - -Weight <UInt16> [<CommonParameters>] -``` - -### CNAME -``` -Remove-AzureRmDnsRecordConfig -RecordSet <DnsRecordSet> -Cname <String> [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsRecordConfig** cmdlet removes a Domain Name System (DNS) record from a record set. -The **RecordSet** object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service. - -To remove a record, all the fields for that record type must match exactly. -You cannot add or remove SOA records. -SOA records are automatically created when a DNS zone is created and automatically deleted when the DNS zone is deleted. - -You can pass the **RecordSet** object to this cmdlet as a parameter or by using the pipeline operator. - -## EXAMPLES - -### Example 1: Remove an A record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet -``` - -This example removes an A record from an existing record set. -If this is the only record in the record set, the result will be an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 2: Remove an AAAA record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet -``` - -This example removes an AAAA record from an existing record set. -If this is the only record in the record set, the result will be an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 3: Remove a CNAME record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet -``` - -This example removes a CNAME record from an existing record set. -Because a CNAME record set can contain at most one record, the result is an empty record set. - -### Example 4: Remove an MX record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet -``` - -This example removes an MX record from an existing record set. -The record name "@" indicates a record set at the zone apex. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 5: Remove an NS record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzureRmDnsRecordSet -``` - -This example removes an NS record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 6: Remove a PTR record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa -PS C:\> Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet -``` - -This example removes a PTR record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 7: Remove an SRV record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet -``` - -This example removes an SRV record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -### Example 8: Remove a TXT record from a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# The above sequence can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet -``` - -This example removes a TXT record from an existing record set. -If this is the only record in the record set, the result is an empty record set. -To remove a record set entirely, see Remove-AzureRmDnsRecordSet. - -## PARAMETERS - -### -Cname -Specifies the domain name for a canonical name (CNAME) record. - -```yaml -Type: String -Parameter Sets: CNAME -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Exchange -Specifies the mail exchange server name for a mail exchange (MX) record. - -```yaml -Type: String -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv4Address -Specifies an IPv4 address for an A record. - -```yaml -Type: String -Parameter Sets: A -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ipv6Address -Specifies an IPv6 address for an AAAA record. - -```yaml -Type: String -Parameter Sets: AAAA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Nsdname -Specifies the name server for a name server (NS) record. - -```yaml -Type: String -Parameter Sets: NS -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the port for a service (SRV) record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference for an MX record. - -```yaml -Type: UInt16 -Parameter Sets: MX -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptrdname -Specifies the target domain name of a pointer (PTR) record. - -```yaml -Type: String -Parameter Sets: PTR -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object that contains the record to remove. - -```yaml -Type: DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target -Specifies the target for an SRV record. - -```yaml -Type: String -Parameter Sets: SRV -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value for a TXT record. - -```yaml -Type: String -Parameter Sets: TXT -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weight -Specifies the weight for an SRV record. - -```yaml -Type: UInt16 -Parameter Sets: SRV -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -You can pipe a **DnsRecordSet** object to this cmdlet. -This is an offline representation of the record set and updates to it do not change DNS responses until after you run Set-AzureRmDnsRecordSet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -This cmdlet returns the modified **RecordSet** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmDnsRecordConfig](./Add-AzureRmDnsRecordConfig.md) - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordSet.md b/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordSet.md deleted file mode 100644 index 9e5e804b9c..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: 505562A4-30BC-44E7-94EF-579763B8D794 -online version: -schema: 2.0.0 ---- - -# Remove-AzureRmDnsRecordSet - -## SYNOPSIS -Deletes a record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmDnsRecordSet -Name <String> -RecordType <RecordType> -ZoneName <String> - -ResourceGroupName <String> [-Force] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Mixed -``` -Remove-AzureRmDnsRecordSet -Name <String> -RecordType <RecordType> -Zone <DnsZone> [-Force] [-PassThru] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-Force] [-PassThru] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsRecordSet** cmdlet deletes the specified record set from the specified zone. -You cannot delete SOA or name server (NS) records that are automatically created at the zone apex. - -You can pass a **RecordSet** object to this cmdlet by using the pipeline operator or as a parameter. -To identify a record set by name and type without using a **RecordSet** object, you must pass the zone as a **DnsZone** object to this cmdlet by using the pipeline operator or as a parameter, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. - -You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. - -When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -You can suppress this by using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Remove a record set -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet -``` - -The first command gets the specified record set, and then stores it in the $RecordSet variable.The second command removes the record set in $RecordSet. - -### Example 2: Remove a record set and suppress all confirmation -``` -PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet -Confirm:$False -Overwrite - -# Alternatively, the record set can be removed as follows. In this case, -# because the record set is specified by name rather than by object, the -# Overwrite parameter is not applicable. - -PS C:\> Remove-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False -``` - -The first command gets the specified record set. - -The second command deletes the record set, even if it has changed in the meantime. -Confirmation prompts are suppressed. - -## PARAMETERS - -### -Force -This parameter is deprecated for this cmdlet. -It will be removed in a future release. - -To control whether this cmdlet prompts you for confirmation, use the *Confirm* parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the **RecordSet** to remove. -When specifying the record set by name, the DNS zone must be specified using either the *Zone* parameter or the *ZoneName* and *ResourceGroupName* parameters. - -Alternatively, the record set can be specified using a **RecordSet** object, passed using the *RecordSet* parameter. - -```yaml -Type: String -Parameter Sets: Fields, Mixed -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -When specifying the record set using a **RecordSet** object, the record set is not deleted if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -This can be suppressed using the *Overwrite* parameter, which deletes the record set regardless of concurrent changes. - -```yaml -Type: SwitchParameter -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** object to remove. - -Alternatively, the record set can be specified using the *Name* and *Zone* parameters, or using the *Name*, *ZoneName*, and *ResourceGroupName* parameters. - -```yaml -Type: DnsRecordSet -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RecordType -Specifies the type of DNS record. - -Valid values are: - -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT - -SOA records are deleted automatically when the zone is deleted. -You cannot manually delete SOA records. - -```yaml -Type: RecordType -Parameter Sets: Fields, Mixed -Aliases: -Accepted values: A, AAAA, CNAME, MX, NS, PTR, SOA, SRV, TXT - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the DNS zone that contains the **RecordSet** to delete. -This parameter is applicable only when the record set and DNS zone are specified using the *Name* and *ZoneName* parameters. - -Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone that contains the **RecordSet** to delete. -This parameter is applicable only when specifying the record set using the *Name* parameter. - -Alternatively, you can specify the record set using either the *RecordSet* parameter, or the *Name*, *ZoneName*, and *ResourceGroupName* parameters. - -```yaml -Type: DnsZone -Parameter Sets: Mixed -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone that contains the **RecordSet** to delete. -You must also specify the *Name* and *ResourceGroupName* parameters. - -Alternatively, the record set can be specified using either the *RecordSet* parameter, or the *Name* and *Zone* parameters. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -You can pipe a **RecordSet** object to this cmdlet. - -## OUTPUTS - -### None -This cmdlet does not generate any output. - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Set-AzureRmDnsRecordSet](./Set-AzureRmDnsRecordSet.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsZone.md b/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsZone.md deleted file mode 100644 index 28b3316436..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Remove-AzureRmDnsZone.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 -online version: -schema: 2.0.0 ---- - -# Remove-AzureRmDnsZone - -## SYNOPSIS -Removes a DNS zone from a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Remove-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Object -``` -Remove-AzureRmDnsZone -Zone <DnsZone> [-Overwrite] [-Force] [-PassThru] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDnsZone** cmdlet permanently deletes a Domain Name System (DNS) zone from a specified resource group. -All record sets contained in the zone are also deleted. - -You can pass a **DnsZone** object using the *Name* parameter or by using the pipeline operator, or alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. - -You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. - -When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). -This provides protection for concurrent zone changes. -This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Remove a zone -``` -PS C:\>Remove-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -``` - -This command removes the zone named myzone.com from the resource group named MyResourceGroup. - -## PARAMETERS - -### -Force -This parameter is deprecated for this cmdlet. -It will be removed in a future release. - -To control whether this cmdlet prompts you for confirmation, use the *Confirm* parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DNS zone that this cmdlet removes. -You must also specify the *ResourceGroupName* parameter. - -Alternatively, you can specify the DNS zone using the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -When specifying the zone using a **DnsZone** object (passed via the pipeline or *Zone* parameter), the zone is not deleted if it has been changed in Azure DNS since the local **DnsZone** object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). -This provides protection for concurrent zone changes. - -This can be suppressed using the *Overwrite* parameter, which deletes the zone regardless of concurrent changes. - -```yaml -Type: SwitchParameter -Parameter Sets: Object -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -passthru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 zone to remove. -You must also specify the *ZoneName* parameter. - -Alternatively, you can specify the DNS zone using a **DnsZone** object, passed via either the pipeline or the *Zone* parameter. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone to delete. -The **DnsZone** object passed can also be passed via the pipeline. - -Alternatively, you can specify the DNS zone to delete by using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -You can pipe a **DnsZone** object to this cmdlet. - -## OUTPUTS - -### None -This cmdlet does not generate any output. - -## NOTES -Due to the potentially high impact of deleting a DNS zone, by default, this cmdlet prompts for confirmation if the $ConfirmPreference Windows PowerShell variable has any value other than None. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Set-AzureRmDnsZone](./Set-AzureRmDnsZone.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsRecordSet.md b/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsRecordSet.md deleted file mode 100644 index 9a41c81115..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsRecordSet.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: 99E6C4DD-11AF-4DC0-848B-39811240BE06 -online version: -schema: 2.0.0 ---- - -# Set-AzureRmDnsRecordSet - -## SYNOPSIS -Updates a DNS record set. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmDnsRecordSet -RecordSet <DnsRecordSet> [-Overwrite] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDnsRecordSet** cmdlet updates a record set in the Azure DNS service from a local **RecordSet** object. - -You can pass a **RecordSet** object as a parameter or by using the pipeline operator. - -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. - -The record set is not updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -You can suppress this behavior using the *Overwrite* parameter, which updates the record set regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Update a record set -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 -PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet - -# These cmdlets can also be piped: - -PS C:\> Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzureRmDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzureRmDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzureRmDnsRecordSet -``` - -The first command uses the Get-AzureRmDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. - -The second and third commands are off-line operations to add two A records to the record set. - -The final command uses the **Set-AzureRmDnsRecordSet** cmdlet to commit the update. - -### Example 2: Update an SOA record -``` -PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone -PS C:\> $RecordSet.Records[0].Email = "admin.myzone.com" -PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet -``` - -The first command uses the **Get-AzureRmDnsRecordset** cmdlet to get the specified record set, and then stores it in the $RecordSet variable. - -The second command updates the specified SOA record in $RecordSet. - -The final command uses the **Set-AzureRmDnsRecordSet** cmdlet to propagate the update in $RecordSet. - -## PARAMETERS - -### -Overwrite -Indicates to update the record set regardless of concurrent changes. - -The record set will not be updated if it has been changed in Azure DNS since the local **RecordSet** object was retrieved. -This provides protection for concurrent changes. -To suppress this behavior, you can use the *Overwrite* parameter, which results in the record set being updated regardless of concurrent changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordSet -Specifies the **RecordSet** to update. - -```yaml -Type: DnsRecordSet -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -You can pass a **RecordSet** object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsRecordSet -This cmdlet returns an object that represents the updated **RecordSet** object. - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsRecordSet](./Get-AzureRmDnsRecordSet.md) - -[New-AzureRmDnsRecordSet](./New-AzureRmDnsRecordSet.md) - -[Remove-AzureRmDnsRecordSet](./Remove-AzureRmDnsRecordSet.md) diff --git a/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsZone.md b/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsZone.md deleted file mode 100644 index 7a4c45de0f..0000000000 --- a/azurermps-2.5.0/AzureRm.Dns/Set-AzureRmDnsZone.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Dns.dll-Help.xml -ms.assetid: E37ADC54-A37B-41BF-BE94-9E4052C234BB -online version: -schema: 2.0.0 ---- - -# Set-AzureRmDnsZone - -## SYNOPSIS -Updates the properties of a DNS zone. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Fields -``` -Set-AzureRmDnsZone -Name <String> -ResourceGroupName <String> [-Tag <Hashtable>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### Object -``` -Set-AzureRmDnsZone -Zone <DnsZone> [-Overwrite] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDnsZone** cmdlet updates the specified DNS zone in the Azure DNS service. -This cmdlet does not update the record sets in the zone. - -You can pass a **DnsZone** object as a parameter or by using the pipeline operator, or -alternatively you can specify the *ZoneName* and *ResourceGroupName* parameters. - -You can use the *Confirm* parameter and $ConfirmPreference Windows PowerShell variable to control -whether the cmdlet prompts you for confirmation. - -When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated -if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides -protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, -which updates the zone regardless of concurrent changes. - -## EXAMPLES - -### Example 1: Update a DNS zone -``` -PS C:\>$Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) -PS C:\> Set-AzureRmDnsZone -Zone $Zone -``` - -The first command gets the zone named myzone.com from the specified resource group, and then stores -it in the $Zone variable. - -The second command updates the tags for $Zone. - -The final command commits the change. - -### Example 2: Update tags for a zone -``` -PS C:\>Set-AzureRmDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) -``` - -This command updates the tags for the zone named myzone.com without first explicitly getting the -zone. - -## PARAMETERS - -### -Name -Specifies the name of the DNS zone to update. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated -if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides -protection for concurrent changes. You can suppress this behavior with the *Overwrite* parameter, -which updates the zone regardless of concurrent changes. - -```yaml -Type: SwitchParameter -Parameter Sets: Object -Aliases: - -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 zone to update. -You must also specify the ZoneName parameter. - -Alternatively, you can specify the zone using a DnsZone object with the *Zone* parameter or the pipeline. - -```yaml -Type: String -Parameter Sets: Fields -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: Fields -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -Specifies the DNS zone to update. - -Alternatively, you can specify the zone using the *ZoneName* and *ResourceGroupName* parameters. - -```yaml -Type: DnsZone -Parameter Sets: Object -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -You can pipe a DnsZone object to this cmdlet. - -## OUTPUTS - -### Microsoft.Azure.Commands.Dns.DnsZone -This cmdlet returns a DnsZone object that represents the updated DNS zone with a new Etag. - -## NOTES -You can use the *Confirm* parameter to control whether this cmdlet prompts you for confirmation. -By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. - -If you specify *Confirm* or *Confirm:$True*, this cmdlet prompts you for confirmation before it runs. -If you specify *Confirm:$False*, the cmdlet does not prompt you for confirmation. - -## RELATED LINKS - -[Get-AzureRmDnsZone](./Get-AzureRmDnsZone.md) - -[New-AzureRmDnsZone](./New-AzureRmDnsZone.md) - -[Remove-AzureRmDnsZone](./Remove-AzureRmDnsZone.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmAutoscaleSetting.md b/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmAutoscaleSetting.md deleted file mode 100644 index 16ad778856..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermautoscalesetting -schema: 2.0.0 ---- - -# Add-AzureRmAutoscaleSetting - -## SYNOPSIS -Creates an Autoscale setting. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UpdateAutoscaleSetting -``` -Add-AzureRmAutoscaleSetting -InputObject <PSAutoscaleSetting> -ResourceGroupName <String> [-DisableSetting] - [-AutoscaleProfile <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile]>] - [-Notification <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### CreateAutoscaleSetting -``` -Add-AzureRmAutoscaleSetting -Location <String> -Name <String> -ResourceGroupName <String> [-DisableSetting] - [-AutoscaleProfile <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile]>] - -TargetResourceId <String> - [-Notification <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmAutoscaleSetting** cmdlet creates an Autoscale setting. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Create an Autoscale setting -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" - -PS C:\> $Profile1 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rules $Rule1, $Rule2 -Name "adios" - -PS C:\> $Profile2 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rules $Rule1, $Rule2 -Name "SecondProfileName" -RecurrenceFrequency Minute -ScheduleDays "1", "2", "3" -ScheduleHours 5, 10, 15 -ScheduleMinutes 15, 30, 45 -ScheduleTimeZone GMT - -PS C:\> Add-AzureRmAutoscaleSetting -Location "East US" -Name "MySetting" -ResourceGroupName "Default-Web-EastUS" -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm" -AutoscaleProfiles $Profile1, $Profile2 -``` - -The first two commands use New-AzureRmAutoscaleRule to create two Autoscale rules, $Rule1 and $Rule2. -The third and fourth commands use New-AzureRmAutoscaleProfile to create Autoscale profiles, $Profile1 and $Profile2, using $Rule1 and $Rule2. -The final command creates an Autoscale setting using the profiles in $Profile1 and $Profile2. - -## PARAMETERS - -### -AutoscaleProfile -Specifies a list of profiles to add to the Autoscale setting, or $Null to add no profile. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile] -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSetting -Disables an existing Autoscale setting. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The complete spec of an AutoscaleSetting - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting -Parameter Sets: UpdateAutoscaleSetting -Aliases: SettingSpec - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the Autoscale setting. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Autoscale setting to create. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Notification -Specifies a list of comma-separated notifications. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the resource associated with the Autoscale setting. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the resource to autoscale. - -```yaml -Type: System.String -Parameter Sets: CreateAutoscaleSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAutoscaleSettingOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleProfile](./New-AzureRmAutoscaleProfile.md) - -[New-AzureRmAutoscaleRule](./New-AzureRmAutoscaleRule.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmLogProfile.md b/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmLogProfile.md deleted file mode 100644 index 9070bc7cd7..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmLogProfile.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 18D5B95E-4CF1-4C79-AE8B-9F4DA49B46A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermlogprofile -schema: 2.0.0 ---- - -# Add-AzureRmLogProfile - -## SYNOPSIS -Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLogProfile -Name <String> [-StorageAccountId <String>] [-ServiceBusRuleId <String>] - [-RetentionInDays <Int32>] -Location <System.Collections.Generic.List`1[System.String]> - [-Category <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLogProfile** cmdlet creates a log profile. -- **Storage Account** - Only standard storage account (premium storage account is not supported) is supported. It could either be of type ARM or Classic. If it's logged to a storage account, the cost of storing the activity log is billed at normal standard storage rates. There could be only one log profile per subscription consequentially only one storage account per subscription can be used to export activity log. -- **Event Hub** - There could be only one log profile per subscription consequentially only one event hub per subscription can be used to export activity log. If activity log is streamed to an event hub, standard event hub pricing will apply. -In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region. -**Note** :- **Failing to set "Global" in the locations will result in a majority of activity log not getting exported.** -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1 : Add a new log profile to export the activity log matching the location condition to a storage account -``` -Add-AzureRmLogProfile -Location "Global","West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount -``` - -## PARAMETERS - -### -Category -Specifies the list of categories. - -```yaml -Type: System.Collections.Generic.List`1[System.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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 location of the log profile. -Valid values: Run below cmdlet to get the latest list of locations. -Get-AzureLocation | Select DisplayName - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the profile. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the retention policy, in days. This is the number of days the logs are preserved in the storage account specified. To retain the data forever set this to **0**. If it's not specified, then it defaults to **0**. Normal standard storage or event hub billing rates will apply for data retention. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusRuleId -Specifies the ID of the Service Bus rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the ID of the Storage account. ID is the fully qualified Resource ID of the storage account for example -/subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfile - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLogProfile](./Get-AzureRmLogProfile.md) - -[Remove-AzureRmLogProfile](./Remove-AzureRmLogProfile.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmMetricAlertRule.md b/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmMetricAlertRule.md deleted file mode 100644 index 6c45d6eb88..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmMetricAlertRule.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A90564B5-57D7-48EB-976D-38C03D930289 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermmetricalertrule -schema: 2.0.0 ---- - -# Add-AzureRmMetricAlertRule - -## SYNOPSIS -Adds or updates a metric-based alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmMetricAlertRule -WindowSize <TimeSpan> -Operator <ConditionOperator> -Threshold <Double> - -TargetResourceId <String> -MetricName <String> -TimeAggregationOperator <TimeAggregationOperator> - -Location <String> [-Description <String>] [-DisableRule] -ResourceGroupName <String> -Name <String> - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmMetricAlertRule** cmdlet adds or updates a metric-based alert rule. -The added rule is associated with a resource group and has a name. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Add a metric alert rule to a website -``` -PS C:\>Add-AzureRMMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -33574ccf-0b01-43b4-aa97-87e6bbcf1c11 Created -``` - -This command creates a metric alert rule for a website. - -### Example 2: Disable a rule -``` -PS C:\>Add-AzureRMMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -96c489f1-8529-46e1-a76d-2c1463ca3116 OK -``` - -This command disables a rule. -If the rule does not exist, it creates it disabled. -If the rule exists, then it just disables it. - -### Example 3: Add a rule with actions -``` -PS C:\>Add-AzureRmMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total -RequestId StatusCode ---------- ---------- -9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK -``` - -This command creates a metric alert rule for a website. - -## PARAMETERS - -### -Action -Specifies a comma-separated list of actions. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableRule -Disables the rule. -If you do not specify this parameter, the rule is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location where the rule is defined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric the rule is monitoring. -Specify this parameter only for metric-based rules. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the relational operator for the condition of the rule. -The acceptable values for this parameter are: -- GreaterThan -- GreaterThanOrEqual -- LessThan -- LessThanOrEqual - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator -Parameter Sets: (All) -Aliases: -Accepted values: GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the resource the rule is monitoring. NOTE: This property cannot be updated for an existing alert rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies the threshold of the rule. - -```yaml -Type: System.Double -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeAggregationOperator -Specifies the aggregation operator to apply to the time window when the rule is being evaluated. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator] -Parameter Sets: (All) -Aliases: -Accepted values: Average, Minimum, Maximum, Total, Last - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowSize -Specifies the time window size for the rule to compute its data. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.TimeSpan - -### Microsoft.Azure.Management.Monitor.Management.Models.ConditionOperator - -### System.Double - -### System.String - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - -[New-AzureRmAlertRuleEmail](./New-AzureRmAlertRuleEmail.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmWebtestAlertRule.md b/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmWebtestAlertRule.md deleted file mode 100644 index 42722bfd00..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Add-AzureRmWebtestAlertRule.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: FBAE5F75-1E28-4F1C-A9ED-20075FFD4AC7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/add-azurermwebtestalertrule -schema: 2.0.0 ---- - -# Add-AzureRmWebtestAlertRule - -## SYNOPSIS -Adds or updates a webtest alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmWebtestAlertRule -MetricName <String> -TargetResourceUri <String> -WindowSize <TimeSpan> - -FailedLocationCount <Int32> [-MetricNamespace <String>] -Location <String> [-Description <String>] - [-DisableRule] -ResourceGroupName <String> -Name <String> - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmWebtestAlertRule** cmdlet adds or updates an alert rule of either metric, event, or webtest type. -The added rule is associated to a resource group and has a name. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Add a webtest alert rule -``` -PS C:\>Add-AzureRmWebtestAlertRule -Name "webtestRule" -Location "East US" -ResourceGroup "Default-Web-EastUS" -WindowSize 00:05:00 -MetricName "metric" -TargetResourceUri ":/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Default-Web-WestUS/providers/microsoft.insights/webtests/leowebtestr1-webtestr1" -Description "Nice Webtest rule" -Failed 3 -RequestId StatusCode ---------- ---------- -9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712 OK -``` - -This command adds or updates a webtest alert rule. - -## PARAMETERS - -### -Action -Specifies a comma-separated list of actions. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 of the rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableRule -Disables the rule. -If you do not specify this parameter, the rule is enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FailedLocationCount -Specifies the failed location count for the webtest rules. -This is similar to the threshold in the other types of rules. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location where the rule is defined. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace for rule. - -```yaml -Type: System.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 rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceUri -Specifies the resource ID of the webtest. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowSize -Specifies the time window size for the rule to compute its data. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.TimeSpan - -### System.Int32 - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAddAlertRuleOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/AzureRM.Insights.md b/azurermps-2.5.0/AzureRm.Insights/AzureRM.Insights.md deleted file mode 100644 index 651968b29b..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/AzureRM.Insights.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -Module Name: AzureRM.Insights -Module Guid: 698c387c-bd6b-41c6-82ce-721f1ef39548 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights -Help Version: 4.0.4.0 -Locale: en-US ---- - -# AzureRM.Insights Module -## Description -This topic displays help topics for the Azure Insights Cmdlets. - -## AzureRM.Insights Cmdlets -### [Add-AzureRmAutoscaleSetting](Add-AzureRmAutoscaleSetting.md) -Creates an Autoscale setting. - -### [Add-AzureRmLogProfile](Add-AzureRmLogProfile.md) -Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. - -### [Add-AzureRmMetricAlertRule](Add-AzureRmMetricAlertRule.md) -Adds or updates a metric-based alert rule. - -### [Add-AzureRmWebtestAlertRule](Add-AzureRmWebtestAlertRule.md) -Adds or updates a webtest alert rule. - -### [Disable-AzureRmActivityLogAlert](Disable-AzureRmActivityLogAlert.md) -Disables an activity log alert and sets its tags. - -### [Enable-AzureRmActivityLogAlert](Enable-AzureRmActivityLogAlert.md) -Enables an activity log alert and sets its Tags. - -### [Get-AzureRmActionGroup](Get-AzureRmActionGroup.md) -Gets action group(s). - -### [Get-AzureRmActivityLogAlert](Get-AzureRmActivityLogAlert.md) -Gets one or more activity log alert resources. - -### [Get-AzureRmAlertHistory](Get-AzureRmAlertHistory.md) -Gets the history of alerts. - -### [Get-AzureRmAlertRule](Get-AzureRmAlertRule.md) -Gets alert rules. - -### [Get-AzureRmAutoscaleHistory](Get-AzureRmAutoscaleHistory.md) -Gets the Autoscale history. - -### [Get-AzureRmAutoscaleSetting](Get-AzureRmAutoscaleSetting.md) -Gets Autoscale settings. - -### [Get-AzureRmDiagnosticSetting](Get-AzureRmDiagnosticSetting.md) -Gets the logged categories and time grains. - -### [Get-AzureRmLog](Get-AzureRmLog.md) -Gets a log of events. - -### [Get-AzureRmLogProfile](Get-AzureRmLogProfile.md) -Gets a log profile. - -### [Get-AzureRmMetric](Get-AzureRmMetric.md) -Gets the metric values of a resource. - -### [Get-AzureRmMetricDefinition](Get-AzureRmMetricDefinition.md) -Gets metric definitions. - -### [New-AzureRmActionGroup](New-AzureRmActionGroup.md) -Creates an ActionGroup reference object in memory. - -### [New-AzureRmActionGroupReceiver](New-AzureRmActionGroupReceiver.md) -Creates an new action group receiver. - -### [New-AzureRmActivityLogAlertCondition](New-AzureRmActivityLogAlertCondition.md) -Creates an new activity log alert condition object in memory. - -### [New-AzureRmAlertRuleEmail](New-AzureRmAlertRuleEmail.md) -Creates an email action for an alert rule. - -### [New-AzureRmAlertRuleWebhook](New-AzureRmAlertRuleWebhook.md) -Creates an alert rule webhook. - -### [New-AzureRmAutoscaleNotification](New-AzureRmAutoscaleNotification.md) -Creates an Autoscale email notification. - -### [New-AzureRmAutoscaleProfile](New-AzureRmAutoscaleProfile.md) -Creates an Autoscale profile. - -### [New-AzureRmAutoscaleRule](New-AzureRmAutoscaleRule.md) -Creates an Autoscale rule. - -### [New-AzureRmAutoscaleWebhook](New-AzureRmAutoscaleWebhook.md) -Creates an Autoscale webhook. - -### [New-AzureRmMetricFilter](New-AzureRmMetricFilter.md) -Creates a metric dimension filter that can be used to query metrics. - -### [Remove-AzureRmActionGroup](Remove-AzureRmActionGroup.md) -Removes an action group. - -### [Remove-AzureRmActivityLogAlert](Remove-AzureRmActivityLogAlert.md) -Removes an activity log alert. - -### [Remove-AzureRmAlertRule](Remove-AzureRmAlertRule.md) -Removes an alert rule. - -### [Remove-AzureRmAutoscaleSetting](Remove-AzureRmAutoscaleSetting.md) -Removes an Autoscale setting. - -### [Remove-AzureRmDiagnosticSetting](Remove-AzureRmDiagnosticSetting.md) -Remove a diagnostic setting for the a resource. - -### [Remove-AzureRmLogProfile](Remove-AzureRmLogProfile.md) -Removes a log profile. - -### [Set-AzureRmActionGroup](Set-AzureRmActionGroup.md) -Creates a new or updates an existing action group. - -### [Set-AzureRmActivityLogAlert](Set-AzureRmActivityLogAlert.md) -Creates a new or sets an existing activity log alert. - -### [Set-AzureRmDiagnosticSetting](Set-AzureRmDiagnosticSetting.md) -Sets the logs and metrics settings for the resource. - diff --git a/azurermps-2.5.0/AzureRm.Insights/Disable-AzureRmActivityLogAlert.md b/azurermps-2.5.0/AzureRm.Insights/Disable-AzureRmActivityLogAlert.md deleted file mode 100644 index 57a47e9766..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Disable-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/disable-azurermactivitylogalert -schema: 2.0.0 ---- - -# Disable-AzureRmActivityLogAlert - -## SYNOPSIS -Disables an activity log alert and sets its tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DisableByNameAndResourceGroup -``` -Disable-AzureRmActivityLogAlert -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableByInputObject -``` -Disable-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisableByResourceId -``` -Disable-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Disable-AzureRmActivityLogAlert** cmdlet disables and activity log alert and allows setting its tags. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. - -## EXAMPLES - -### Example 1: Disable an activity log alert -``` -PS C:\>Disable-AzureRmActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts" -``` - -This command disables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts. -This command changes the tags property of the activity log alert called alert1 and disables it. - -### Example 2: Disable an activity log alert using a PSActivityLogAlertResource object as input -``` -PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" -PS C:\>Disable-AzureRmActivityLogAlert -InputObject $obj -``` - -This command disables an activity log alert called alert1. For this it uses a PSActivityLogAlertResource object as input argument. - -### Example 3: Disable the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Disable-AzureRmActivityLogAlert -``` - -This command disables the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: DisableByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: DisableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: DisableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: DisableByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Enable-AzureRmActivityLogAlert.md b/azurermps-2.5.0/AzureRm.Insights/Enable-AzureRmActivityLogAlert.md deleted file mode 100644 index 80d293f0d3..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Enable-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/enable-azurermactivitylogalert -schema: 2.0.0 ---- - -# Enable-AzureRmActivityLogAlert - -## SYNOPSIS -Enables an activity log alert and sets its Tags. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EnableByNameAndResourceGroup -``` -Enable-AzureRmActivityLogAlert -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnableByInputObject -``` -Enable-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### EnableByResourceId -``` -Enable-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Enable-AzureRmActivityLogAlert** cmdlet allows enabling an activity log alert and setting its tags. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. - -## EXAMPLES - -### Example 1: Disable an activity log alert -``` -PS C:\>Enable-AzureRmActivityLogAlert -Name "alert1" -ResourceGroupName "Default-ActivityLogsAlerts" -``` - -This command enables the activity log alert called alert1 in the resource group Default-ActivityLogsAlerts. - -### Example 2: Enable an activity log alert using a PSActivityLogAlertResource object as input -``` -PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" -PS C:\>Enable-AzureRmActivityLogAlert -InputObject $obj -``` - -This command enables an activity log alert called alert1. For this it uses a PSActivityLogAlertResource object as input argument. - -### Example 3: Enable the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Enable-AzureRmActivityLogAlert -``` - -This command enables the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tags properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: EnableByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: EnableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: EnableByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: EnableByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActionGroup.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActionGroup.md deleted file mode 100644 index 1ce80a6950..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActionGroup.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 1CA26790-C791-4BFD-B986-70F28E3B095B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermactiongroup -schema: 2.0.0 ---- - -# Get-AzureRmActionGroup - -## SYNOPSIS -Gets action group(s). - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySubscriptionOrResourceGroup (Default) -``` -Get-AzureRmActionGroup [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureRmActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmActionGroup** cmdlet gets one or more action groups. - -## EXAMPLES - -### Example 1: Get an action group by subscription ID -``` -PS C:\>Get-AzureRmActionGroup -``` - -This command lists all the action group for the current subscription. - -### Example 2: Get action groups for the given resource group -``` -PS C:\>Get-AzureRmActionGroup -ResourceGroup "Default-activityLogAlerts" -``` - -This command lists action groups for the given resource group. - -### Example 3: Get an action group. -``` -PS C:\>Get-AzureRmActionGroup -ResourceGroup "Default-activityLogAlerts" -Name "actionGroup1" -``` - -This command lists one (a list with a single element) action group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionOrResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByName -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActivityLogAlert.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActivityLogAlert.md deleted file mode 100644 index cc1f8e22a8..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermactivitylogalert -schema: 2.0.0 ---- - -# Get-AzureRmActivityLogAlert - -## SYNOPSIS -Gets one or more activity log alert resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup -``` -Get-AzureRmActivityLogAlert [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmActivityLogAlert [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmActivityLogAlert** cmdlet gets one or more activity log alert resources. - -## EXAMPLES - -### Example 1: Get a activity log alerts by subscription ID -``` -PS C:\>Get-AzureRmActivityLogAlert -``` - -This command lists all the activity log alerts for the current subscription. - -### Example 2: Get activity log alerts for the given resource group -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroupName "Default-activityLogAlerts" -``` - -This command lists activity log alerts for the given resource group. - -### Example 3: Get an activity log alert. -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroupName "Default-activityLogAlerts" -Name "alert1" -``` - -This command lists one (a list with a single element) activity log alert. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource exists. -If Name is not null or empty, this parameter must contain and non empty string. - -```yaml -Type: System.String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: - -Required: False -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - - - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertHistory.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertHistory.md deleted file mode 100644 index 226175ce3a..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertHistory.md +++ /dev/null @@ -1,406 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 1EDFCAC4-6A66-4124-8192-B7F0D3C5BCFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermalerthistory -schema: 2.0.0 ---- - -# Get-AzureRmAlertHistory - -## SYNOPSIS -Gets the history of alerts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAlertHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] - [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAlertHistory** cmdlet gets the history of alerts as they are enabled, disabled, fired, resolved, and so on. - -## EXAMPLES - -### Example 1: Get the alert history -``` -PS C:\>Get-AzureRmAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -DetailedOutput -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: - garyyang1 (Default-Web-EastUS) -EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:14:45 PM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc - 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 -Level : Informational -OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -OperationName : ResolveAlert -Properties : - RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Resolved -SubmissionTimestamp : 2/11/2015 7:14:45 PM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : 66277c94-2097-4f5f-860d-e585f1206cd7 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.web/sites/garyyang1/events/66277c94-2097-4f5f-860d-e585f1206cd7/ticks/6355927828650595 - 14 -Level : Error -OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : - RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.web -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.web/sites/garyyang1 -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 - ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 -Level : Error -OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : - RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d - RuleDescription: - Threshold : 3 - WindowSizeInMinutes: 5 - Aggregation : Total - Operator : GreaterThan - MetricName : CpuTime - MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -``` - -This command gets the alert history for the specified time frame for the current subscription. - -### Example 2: Get alert history for a specified resource -``` -PS C:\>Get-AzureRmAlertHistory -StartTime 2015-02-11T11:00:00 -EndTime 2015-02-11T12:00:00 -ResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d" -DetailedOutput - -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' has been resolved for Website: - garyyang1 (Default-Web-EastUS) -EventDataId : 769fab1c-fc9f-4e18-bc3a-fa79fbdd3616 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:14:45 PM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/769fab1c-fc - 9f-4e18-bc3a-fa79fbdd3616/ticks/635592788857929926 -Level : Informational -OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzg4ODU3OTI5OTI2 -OperationName : ResolveAlert -Properties : -RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleDescription: -Threshold : 3 -WindowSizeInMinutes: 5 -Aggregation : Total -Operator : GreaterThan -MetricName : CpuTime -MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Resolved -SubmissionTimestamp : 2/11/2015 7:14:45 PM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -Authorization : -Caller : Microsoft.Insights/alertRules -Claims : - http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/alertRules -CorrelationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -Description : 'CpuTime GreaterThan 3 ([Count]) in the last 5 minutes' was activated for Website: garyyang1 - (Default-Web-EastUS) -EventDataId : ec9f7b3c-c6ea-4b45-bd15-ff43e38491e3 -EventName : Alert -EventSource : microsoft.insights/alertrules -EventTimestamp : 2/11/2015 7:04:46 PM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/events/ec9f7b3c-c6 - ea-4b45-bd15-ff43e38491e3/ticks/635592782865059514 -Level : Error -OperationId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d/incidents/L3N1YnNj - cmlwdGlvbnMvYTkzZmIwN2MtNmM5My00MGJlLWJmM2ItNGYwZGViYTEwZjRiL3Jlc291cmNlR3JvdXBzL0RlZmF1bHQtV2Vi - LUVhc3RVUy9wcm92aWRlcnMvbWljcm9zb2Z0Lmluc2lnaHRzL2FsZXJ0cnVsZXMvY2hlY2tydWxlMy00YjEzNTQwMS1hMzBj - LTQyMjQtYWUyMS1mYTUzYTViZDI1M2QwNjM1NTkyNzgyODY1MDU5NTE0 -OperationName : ActivateAlert -Properties : -RuleUri : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleName : checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -RuleDescription: -Threshold : 3 -WindowSizeInMinutes: 5 -Aggregation : Total -Operator : GreaterThan -MetricName : CpuTime -MetricUnit : Count -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/alertrules/checkrule3-4b135401-a30c-4224-ae21-fa53a5bd253d -Status : Activated -SubmissionTimestamp : 2/11/2015 7:04:46 PM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -``` - -This command gets the alert rule-related events for a specified resource. - -## PARAMETERS - -### -Caller -Specifies the caller. - -```yaml -Type: System.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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID the rule is associated with. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default is the current local time minus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies the status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS - - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertRule.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertRule.md deleted file mode 100644 index fdb0bac3d2..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAlertRule.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A837077C-0A79-431C-93D2-799B2134EE69 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermalertrule -schema: 2.0.0 ---- - -# Get-AzureRmAlertRule - -## SYNOPSIS -Gets alert rules. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroup -``` -Get-AzureRmAlertRule -ResourceGroupName <String> [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByName -``` -Get-AzureRmAlertRule -ResourceGroupName <String> -Name <String> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceUri -``` -Get-AzureRmAlertRule -ResourceGroupName <String> -TargetResourceId <String> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAlertRule** cmdlet gets an alert rule by its name or URI, or all alert rules from a specified resource group. - -## EXAMPLES - -### Example 1: Get alert rules for a resource group -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -``` - -This command gets all of the alert rules for the resource group named Default-Web-CentralUS. -The output does not contain details about the rules because the *DetailedOutput* parameter is not specified. - -### Example 2: Get an alert rule by name -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -``` - -This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. -Because the *DetailedOutput* parameter is not specified, the output contains only basic information about the alert rule. - -### Example 3: Get an alert rule by name with detailed output -``` -PS C:\>Get-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -DetailedOutput -``` - -This command gets the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8. -The *DetailedOutput* parameter is specified, so the output is detailed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -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 alert rule to get. - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the ID of the target resource. - -```yaml -Type: System.String -Parameter Sets: GetByResourceUri -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAlertRule - -## NOTES - -## RELATED LINKS - - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Remove-AzureRmAlertRule](./Remove-AzureRmAlertRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleHistory.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleHistory.md deleted file mode 100644 index 98018b6f49..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleHistory.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A70F4C03-E842-45D5-9323-DC5B14B569F1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermautoscalehistory -schema: 2.0.0 ---- - -# Get-AzureRmAutoscaleHistory - -## SYNOPSIS -Gets the Autoscale history. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutoscaleHistory [-ResourceId <String>] [-StartTime <DateTime>] [-EndTime <DateTime>] - [-Status <String>] [-Caller <String>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAutoscaleHistory** cmdlet gets the history of events related to an Autoscale setting. - -## EXAMPLES - -### Example 1: Get all events associated with a subscription -``` -PS C:\>Get-AzureRmAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -DetailedOutput -``` - -This command gets all of the Autoscale-related events associated with the current subscription. - -### Example 2: GetAutoscaleHistory for a particular resource -``` -PS C:\>Get-AzureRmAutoscaleHistory -StartTime 2015-02-09T18:35:00 -EndTime 2015-02-09T18:40:00 -ResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS" -DetailedOutput -Authorization : -Caller : Microsoft.Insights/autoscaleSettings -Claims : http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn: Microsoft.Insights/autoscaleSettings -CorrelationId : ac5b03ca-05d4-4811-9c27-0314a145f785 -Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93-40be-bf3b-4f0deb - a10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm' - from 1 instances count to 2 instances count. -EventDataId : c554f7ed-514c-449c-9338-13e15b4b56a3 -EventName : AutoscaleAction -EventSource : microsoft.insights/autoscalesettings -EventTimestamp : 2/10/2015 2:38:19 AM -HttpRequest : -Id : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS/events/c554f7ed-514c-4 - 49c-9338-13e15b4b56a3/ticks/635591326997519815 -Level : Informational -OperationId : ac5b03ca-05d4-4811-9c27-0314a145f785 -OperationName : ScaleUp -Properties : -Description : The autoscale engine attempting to scale resource '/subscriptions/a93fb07c-6c93 - -40be-bf3b-4f0deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/De - faultServerFarm' from 1 instances count to 2 instances count. -ResourceName : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web- - EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -OldInstancesCount: 1 -NewInstancesCount: 2 -ActiveAutoscaleProfile: { - "Name": "No scheduled times", - "Capacity": { - "Minimum": "1", - "Maximum": "3", - "Default": "1" - }, - "Rules": [ - { - "MetricTrigger": { - "Name": "CpuPercentage", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT45M", - "TimeAggregation": "Average", - "Operator": "GreaterThanOrEqual", - "Threshold": 14.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Increase", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT5M" - } - }, - { - "MetricTrigger": { - "Name": "CpuPercentage", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT45M", - "TimeAggregation": "Average", - "Operator": "LessThanOrEqual", - "Threshold": 4.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Decrease", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT2H" - } - }, - { - "MetricTrigger": { - "Name": "BytesReceived", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT10M", - "TimeAggregation": "Average", - "Operator": "LessThanOrEqual", - "Threshold": 50.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Decrease", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT10M" - } - }, - { - "MetricTrigger": { - "Name": "BytesReceived", - "Namespace": "", - "Resource": "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default- - Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm", - "ResourceLocation": "East US", - "TimeGrain": "PT1M", - "Statistic": "Average", - "TimeWindow": "PT5M", - "TimeAggregation": "Average", - "Operator": "GreaterThanOrEqual", - "Threshold": 100.0, - "Source": "WebsiteDedicated:eastuswebspace:DefaultServerFarm" - }, - "ScaleAction": { - "Direction": "Increase", - "Type": "ChangeCount", - "Value": "1", - "Cooldown": "PT10M" - } - } - ] - } -ResourceGroupName : Default-Web-EastUS -ResourceProviderName : microsoft.insights -ResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/ - microsoft.insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Status : Succeeded -SubmissionTimestamp : 2/10/2015 2:38:19 AM -SubscriptionId : b93fb07a-6f93-30be-bf3e-4f0deca15f4f -SubStatus : -``` - -This command gets all Autoscale-related events associated with a particular resource identified by the resource's ID (essentially, the ResourceUri). - -## PARAMETERS - -### -Caller -Specifies a caller. - -```yaml -Type: System.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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation included detailed output. -If you do not specify this parameter, the output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID to which the autoscale setting is associated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -This parameter is optional. -The default is the current local time minus one hour. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies a filter by status. -This parameter is optional. -The fault is an empty string (i.e. -no filter) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleSetting.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleSetting.md deleted file mode 100644 index f8ef139dbd..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 989CE245-FD1D-4E1D-90A2-2D7DA3975D0B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermautoscalesetting -schema: 2.0.0 ---- - -# Get-AzureRmAutoscaleSetting - -## SYNOPSIS -Gets Autoscale settings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmAutoscaleSetting -ResourceGroupName <String> [-Name <String>] [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAutoscaleSetting** cmdlet gets all Autoscale settings associated with a resource group or a specified Autoscale setting. - -## EXAMPLES - -### Example 1: Get Autoscale settings -``` -PS C:\>Get-AzureRmAutoscaleSetting -ResourceGroup "Default-Web-EastUS" -DetailedOutput -resourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft. - insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Location : East US -Name : DefaultServerFarm-Default-Web-EastUS -Properties : -Enabled : True -Profiles : -Capacity : -Default : 1 -Minimum : 3 -Maximum : 1 -FixedDate : -Name : No scheduled times -Recurrence : -Rules : -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 14 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 00:05:00 -Direction : Increase -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 4 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 02:00:00 -Direction : Decrease -Type : ChangeCount -Value : 1 - -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 50 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:10:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 100 - TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:05:00 -ScaleAction : -Cooldown : 00:10:00 - Direction : Increase -Type : ChangeCount -Value : 1 - TargetResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/ - providers/microsoft.web/serverFarms/DefaultServerFarm -Tags : {[$type, Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, - Microsoft.WindowsAzure.Management.Common.Storage], [hidden-link:/subscriptions/a93fb07c-6c93-40be-bf3b-4f0 - deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm, - Resource]} -``` - -This command gets the Autoscale settings assigned to the resource group Default-Web-EastUS. - -### Example 2: Get an Autoscale setting by name -``` -PS C:\>Get-AzureRmAutoscaleSetting -ResourceGroupName "Default-Web-EastUS" -Name "DefaultServerFarm-Default-Web-EastUS" -DetailedOutput -resourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft. - insights/autoscalesettings/DefaultServerFarm-Default-Web-EastUS -Location : East US -Name : DefaultServerFarm-Default-Web-EastUS -Properties : -Enabled : True -Profiles : -Capacity : -Default : 1 -Minimum : 3 -Maximum : 1 -FixedDate : -Name : No scheduled times -Recurrence : -Rules : -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 14 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 00:05:00 -Direction : Increase -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : CpuPercentage -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 4 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:45:00 -ScaleAction : -Cooldown : 02:00:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : LessThanOrEqual -Statistic : Average -Threshold : 50 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:10:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Decrease -Type : ChangeCount -Value : 1 -MetricTrigger : -MetricName : BytesReceived -MetricResourceId : /subscriptions/a93fb07c-6c93-40be-bf3b-4f0deba10f4 - b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm -Operator : GreaterThanOrEqual -Statistic : Average -Threshold : 100 -TimeAggregation : Average -TimeGrain : 00:01:00 -TimeWindow : 00:05:00 -ScaleAction : -Cooldown : 00:10:00 -Direction : Increase -Type : ChangeCount -Value : 1 -TargetResourceId : /subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/ - providers/microsoft.web/serverFarms/DefaultServerFarm -Tags : {[$type, Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, - Microsoft.WindowsAzure.Management.Common.Storage], [hidden-link:/subscriptions/a93fb07c-6c93-40be-bf3b-4f0 - deba10f4b/resourceGroups/Default-Web-EastUS/providers/microsoft.web/serverFarms/DefaultServerFarm, - Resource]} -``` - -This command gets the Autoscale setting named DefaultServerFarm-Default-Web-EastUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation displays full details in the output. - -```yaml -Type: System.Management.Automation.SwitchParameter -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 setting to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSAutoscaleSetting - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmDiagnosticSetting.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmDiagnosticSetting.md deleted file mode 100644 index e5b58dc6e7..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 60B497F6-98A2-4C60-B142-FF5CD123362D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermdiagnosticsetting -schema: 2.0.0 ---- - -# Get-AzureRmDiagnosticSetting - -## SYNOPSIS -Gets the logged categories and time grains. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmDiagnosticSetting [-ResourceId] <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDiagnosticSetting** cmdlet gets the categories and time grains that are logged for a resource. -A time grain is the aggregation interval of a metric. - -## EXAMPLES - -### Example 1: Get the status of the logging categories and time grains -``` -PS C:\>Get-AzureRmDiagnosticSetting -ResourceId "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.keyvault/KeyVaults/ContosoKeyVault" -StorageAccountId : /subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.storage/accounts/ContosoStorageAccount -StorageAccountName : ContosoStorageAccount001 -Metrics - -Logs -Enabled : True -Category : AuditEvent -``` - -This command gets the categories and time grains that are logged for an Azure Key Vault with a *ResourceId* of /subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/ResourceGroups/ContosoRG/providers/microsoft.keyvault/KeyVaults/ContosoKeyVault. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. If not given the call default to "service" as it was in the previous API. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings - -## NOTES - -## RELATED LINKS - -[Set-AzureRmDiagnosticSetting](./Set-AzureRmDiagnosticSetting.md) -[Remove-AzureRmDiagnosticSetting](./Remove-AzureRmDiagnosticSetting.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLog.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLog.md deleted file mode 100644 index 5fbb664d7a..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLog.md +++ /dev/null @@ -1,395 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermlog -schema: 2.0.0 ---- - -# Get-AzureRmLog - -## SYNOPSIS -Gets a log of events. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByCorrelationId -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-CorrelationId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceId -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceId] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByResourceGroup -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceGroupName] <String> [-MaxRecord <Int32>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceProvider -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-ResourceProvider] <String> [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetBySubscription -``` -Get-AzureRmLog [-StartTime <DateTime>] [-EndTime <DateTime>] [-Status <String>] [-Caller <String>] - [-DetailedOutput] [-MaxRecord <Int32>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLog** cmdlet gets a log of events. -The events can be associated with the current subscription ID, correlation ID, resource group, resource ID, or resource provider. - -## EXAMPLES - -### Example 1: Get an event log by subscription ID -``` -PS C:\>Get-AzureRmLog -``` - -This command lists at most 1000 events associated with the user's subscription ID that took place 7 days from the current date/time. - -### Example 2: Get an event log by subscription ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -MaxEvents 100 -``` - -This command lists at most 100 events associated with the user's subscription ID that took place 7 days from the current date/time. - -### Example 3: Get an event log by subscription ID with a start time. -``` -PS C:\>Get-AzureRmLog -StartTime 2017-06-01T10:30 -``` - -This command lists at most 1000 events associated with the user's subscription ID that took place on or after 2017-06-01T10:30 local time if that date/time is not older than 90 days from the current date/time. - -### Example 4: Get an event log by subscription ID with a start time and end time. -``` -PS C:\>Get-AzureRmLog -StartTime 2017-04-01T10:30 -EndTime 2017-04-14T11:30 -``` - -This command lists at most 1000 of the events associated with the user's subscription ID that took place on or after 2017-04-01T10:30 local time, and before 2017-04-14T11:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 5: Get an event log by correlation ID -``` -PS C:\>Get-AzureRmLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place 7 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 6: Get an event log by correlation ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified correlation ID that took place 7 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 7: Get an event log by correlation ID and start time -``` -PS C:\>Get-AzureRmLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -StartTime 2017-05-22T04:30:00 -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. -**NOTE**: this is usually only one event. - -### Example 8: Get an event log by correlation ID with start time and end time -``` -PS C:\>Get-AzureRmLog -CorrelationId "60c694d0-e46f-4c12-bed1-9b7aef541c23" -StartTime 2017-04-15T04:30:00 -EndTime 2017-04-25T12:30:00 -``` - -This command lists at most 1000 events associated with the specified correlation ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 9: Get an event log for a resource group -``` -PS C:\>Get-AzureRmLog -ResourceGroupName "Contoso-Web-CentralUS" -``` - -This command lists at most 1000 the events associated with the specified resource group that took place 7 days from the current date/time. - -### Example 10: Get an event log for a resource group with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource group that took place 7 days from the current date/time. - -### Example 11: Get an event log for a resource group by start time -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-05-22T04:30:00 -``` - -This command lists at most 1000 evetns associated with the specified resource group that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 12: Get an event log for a resource group with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceGroup "Contoso-Web-CentralUS" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource group that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 13: Get an event log by resource ID -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -``` - -This command lists at most 1000 events associated with the specified resource ID that took place 7 days from the current date/time. - -### Example 14: Get an event log by resource ID with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource ID that took place 7 days from the current date/time. - -### Example 15: Get an event log by resource ID with a start time -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-05-22T04:30 -``` - -This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 16: Get an event log by resource ID with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceId "/subscriptions/623d50f1-4fa8-4e46-a967-a9214aed43ab/ResourceGroups/Contoso-Web-CentralUS/providers/Microsoft.Web/ServerFarms/Contoso1" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource ID that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -### Example 17: Get an event log by resource provider -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -``` - -This command lists at most 1000 events associated with the specified resource provider that took place 7 days from the current date/time. - -### Example 18: Get an event log by resource provider with a maximum number of events -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -MaxEvents 100 -``` - -This command lists at most 100 events associated with the specified resource provider that took place 7 days from the current date/time. - -### Example 19: Get an event log by resource provider with a start time -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -StartTime 2017-05-22T04:30 -``` - -This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-05-22T04:30:00 local time if the start time is not older than 90 days from the current date/time. - -### Example 20: Get an event log by resource provider with a start time and end time -``` -PS C:\>Get-AzureRmLog -ResourceProvider "Microsoft.Web" -StartTime 2017-04-15T04:30 -EndTime 2017-04-25T12:30 -``` - -This command lists at most 1000 events associated with the specified resource provider that took place on or after 2017-04-15T04:30 local time, but before 2017-04-25T12:30 local time if the whole date/time range is not older than 90 days from the current date/time, i.e.: the retention period. - -## PARAMETERS - -### -Caller -Specifies a caller. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CorrelationId -Specifies the correlation ID. -This parameter is required. - -```yaml -Type: System.String -Parameter Sets: GetByCorrelationId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this cmdlet displays detailed output. -By default, output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Switch not present = False, i.e. output summarized -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default value is the current time. -The value must be later than *StartTime*. -You can use the Get-Date cmdlet to get a **DateTime** object. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Current date (time: 00:00:00 AM) + 1 day -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxRecord -Specifies the total number of records to fetch for the specified filter. -The default value is 1000 and the maximum value accepted is 100000. Negative values and 0 are ignored and the default value will be used. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1000 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroup -Aliases: ResourceGroup - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID. - -```yaml -Type: System.String -Parameter Sets: GetByResourceId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceProvider -Specifies a filter by resource provider. - -```yaml -Type: System.String -Parameter Sets: GetByResourceProvider -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default value is *EndTime* minus seven days. -You can use the Get-Date cmdlet to get a **DateTime** object. - -```yaml -Type: System.Nullable`1[System.DateTime] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: EndTime - 7 days -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Status -Specifies the status. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.String - -### System.Management.Automation.SwitchParameter - -### System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSEventData - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLogProfile.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLogProfile.md deleted file mode 100644 index bcc645cc67..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmLogProfile.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 019EFD94-4087-45F6-812D-FBDFE1B2E48A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermlogprofile -schema: 2.0.0 ---- - -# Get-AzureRmLogProfile - -## SYNOPSIS -Gets a log profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLogProfile [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLogProfile** cmdlet gets a log profile. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 log profile to get. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSLogProfileCollection - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLogProfile](./Add-AzureRmLogProfile.md) - -[Remove-AzureRmLogProfile](./Remove-AzureRmLogProfile.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetric.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetric.md deleted file mode 100644 index 30af87f180..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetric.md +++ /dev/null @@ -1,444 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: EAFB9C98-000C-4EAC-A32D-6B0F1939AA2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermmetric -schema: 2.0.0 ---- - -# Get-AzureRmMetric - -## SYNOPSIS -Gets the metric values of a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetWithDefaultParameters (Default) -``` -Get-AzureRmMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-StartTime <DateTime>] [-EndTime <DateTime>] - [[-MetricName] <String[]>] [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetWithFullParameters -``` -Get-AzureRmMetric [-ResourceId] <String> [-TimeGrain <TimeSpan>] [-AggregationType <AggregationType>] - [-StartTime <DateTime>] [-EndTime <DateTime>] [-Top <Int32>] [-OrderBy <String>] [-MetricNamespace <String>] - [-ResultType <ResultType>] [-MetricFilter <String>] [-MetricName] <String[]> [-DetailedOutput] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMetric** cmdlet gets the metric values for a specified resource. - -## EXAMPLES - -### Example 1: Get a metric with summarized output -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DimensionName : -DimensionValue : -Name : AverageResponseTime -EndTime : 3/20/2015 6:40:46 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, - Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:40:00 PM -TimeGrain : 00:01:00 -Unit : Seconds -DimensionName : -DimensionValue : -Name : AverageMemoryWorkingSet -EndTime : 3/20/2015 6:40:46 PM -MetricValues : {Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue, - Microsoft.Azure.Insights.Models.MetricValue, Microsoft.Azure.Insights.Models.MetricValue...} -Properties : {} -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:40:00 PM -TimeGrain : 00:01:00 -Unit : Bytes -``` - -This command gets the metric values for website3 with a time grain of 1 minute. - -### Example 2: Get a metric with detailed output -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -TimeGrain 00:01:00 -DetailedOutput -MetricValues : - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:37:00 PM - Total : 0 - Average : 0.106 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:39:00 PM - Total : 0.106 - Average : 0.064 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:41:00 PM - Total : 0.064 -Properties : -DimensionName : -DimensionValue : -Name : AverageResponseTime -EndTime : 3/20/2015 6:43:33 PM -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:43:00 PM -TimeGrain : 00:01:00 -Unit : Seconds -``` - -This command gets the metric values for website3 with a time grain of 1 minute. -The output is detailed. - -### Example 3: Get detailed output for a specified metric -``` -PS C:\>Get-AzureRmMetric -ResourceId "/subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3" -MetricNames "Requests" -TimeGrain 00:01:00 -DetailedOutput -MetricValues : - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:39:00 PM - Total : 1 - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:41:00 PM - Total : 1 - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:43:00 PM - Total : 0 - Average : 1 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:44:00 PM - Total : 1 - Average : 0 - Count : 1 - Last : - Maximum : - Minimum : - Properties : - Timestamp : 3/20/2015 6:45:00 PM - Total : 0 -Properties : -DimensionName : -DimensionValue : -Name : Requests -EndTime : 3/20/2015 6:47:56 PM -ResourceId : /subscriptions/e3f5b07d-3c39-4b0f-bf3b-40fdeba10f2a/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website3 -StartTime : 3/20/2015 5:47:00 PM -TimeGrain : 00:01:00 -Unit : Count -``` - -This command gets detailed output for the Requests metric. - -### Example 4: Get summarized output for a specified metric with specified dimension filter -``` -PS C:\> $dimFilter = @((New-AzureRmMetricFilter -Dimension City -Operator eq -Values "Seattle","Toronto"), (New-AzureRmMetricDimensionFilter -Dimension AuthenticationType -Operator eq -Values User)) - -PS C:\> Get-AzureRmMetricValues -ResourceId <resourcId> -MetricName PageViews -TimeGrain PT5M -MetricFilter $dimFilter -StartTime 2018-02-01T12:00:00Z -EndTime 2018-02-01T12:10:00Z -AggregationType -Average -ResourceId : [ResourceId] -MetricNamespace : Microsoft.Insights/ApplicationInsights -Metric Name : - LocalizedValue : Page Views - Value : PageViews -Unit : Seconds -Timeseries : - City : Seattle - AuthenticationType : User - - Timestamp : 2018-02-01 12:00:00 PM - Average : 3518 - - Timestamp : 2018-02-01 12:05:00 PM - Average : 1984 - - City : Toronto - AuthenticationType : User - - Timestamp : 2018-02-01 12:00:00 PM - Average : 894 - - Timestamp : 2018-02-01 12:05:00 PM - Average : 967 -``` - -This command gets summarized output for the PageViews metric with specified dimesion filter and aggregation type. - -## PARAMETERS - -### -AggregationType -The aggregation type of the query - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.AggregationType] -Parameter Sets: GetWithFullParameters -Aliases: -Accepted values: None, Average, Count, Minimum, Maximum, Total - -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. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this cmdlet displays detailed output. -By default, output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end time of the query in local time. -The default is the current time. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricFilter -Specifies the metric dimension filter to query metrics for. - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricName -Specifies an array of names of metrics. - -```yaml -Type: System.String[] -Parameter Sets: GetWithDefaultParameters -Aliases: MetricNames - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: GetWithFullParameters -Aliases: MetricNames - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace to query metrics for. - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrderBy -Specifies the aggregation to use for sorting results and the direction of the sort (Example: sum asc). - -```yaml -Type: System.String -Parameter Sets: GetWithFullParameters -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResultType -Specifies the result type to be returned (metadata or data). - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Management.Monitor.Models.ResultType] -Parameter Sets: GetWithFullParameters -Aliases: -Accepted values: Data, Metadata - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the start time of the query in local time. -The default is the current local time minus one hour. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeGrain -Specifies the time grain of the metric as a **TimeSpan** object in the format hh:mm:ss. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Top -Specifies the maximum number of records to retrieve (default:10), to be specified with $filter. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: GetWithFullParameters -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.TimeSpan - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.AggregationType, Microsoft.Azure.Management.Monitor, Version=0.19.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.DateTime - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[Microsoft.Azure.Management.Monitor.Models.ResultType, Microsoft.Azure.Management.Monitor, Version=0.19.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetric - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetricDefinition](./Get-AzureRmMetricDefinition.md) -[New-AzureRmMetricFilter](./New-AzureRmMetricFilter.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetricDefinition.md b/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetricDefinition.md deleted file mode 100644 index 1d0b4a77d8..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Get-AzureRmMetricDefinition.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7915A7AC-5A47-4868-B846-2896BCEBFAB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/get-azurermmetricdefinition -schema: 2.0.0 ---- - -# Get-AzureRmMetricDefinition - -## SYNOPSIS -Gets metric definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmMetricDefinition [-ResourceId] <String> [-MetricName <String[]>] [-MetricNamespace <String>] - [-DetailedOutput] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmMetricDefinition** cmdlet gets metric definitions. - -## EXAMPLES - -### Example 1: Get metric definitions for a resource -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -Name : CpuTime -Dimensions : {} -MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability} -PrimaryAggregationType : Total -Properties : {} -ResourceUri : -Unit : Seconds -Name : Requests -Dimensions : {} -MetricAvailabilities : {Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability, - Microsoft.Azure.Insights.Models.MetricAvailability} -PrimaryAggregationType : Total -Properties : {} -ResourceUri : -Unit : Count -``` - -This command gets the metrics definitions for the specified resource. - -### Example 2: Get metric definitions with detailed output -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : CpuTime -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Seconds -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : Requests -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Count -``` - -This command gets the metric definitions for website2. -The output is detailed. - -### Example 3: Get metric definitions by name -``` -PS C:\>Get-AzureRmMetricDefinition -ResourceId "/subscriptions/d33fb0c7-69d3-40be-e35b-4f0deba70fff/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/website2" -DetailedOutput -MetricNames "BytesSent,CpuTime" -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : CpuTime -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Seconds -Dimensions : -MetricAvailabilities : - Location : - Retention : 2.00:00:00 - Values : 00:01:00 - Location : - Retention : 30.00:00:00 - Values : 01:00:00 - Location : - Retention : 90.00:00:00 - Values : 1.00:00:00 -Name : BytesSent -Properties : -PrimaryAggregationType : Total -ResourceUri : -Unit : Bytes -``` - -This command gets definitions for the BytesSent and CpuTime metrics. -The output is detailed. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedOutput -Indicates that this operation included detailed output. -If you do not specify this parameter, the output is summarized. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricName -Specifies an array of names of metrics. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricNamespace -Specifies the metric namespace to query metric definitions for. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSMetricDefinition - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetric](./Get-AzureRmMetric.md) -[New-AzureRmMetricFilter](./New-AzureRmMetricFilter.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroup.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroup.md deleted file mode 100644 index f2a060161a..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroup.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactiongroup -schema: 2.0.0 ---- - -# New-AzureRmActionGroup - -## SYNOPSIS -Creates an ActionGroup reference object in memory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmActionGroup -ActionGroupId <String> - [-WebhookProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActionGroup** cmdlet creates an action group reference object in memory. - -## EXAMPLES - -### Example 1: Create an action group reference object in memory -``` -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -``` - -## PARAMETERS - -### -ActionGroupId -The Id/name of the action group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebhookProperty -The webhook properties of the action group - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroupReceiver.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroupReceiver.md deleted file mode 100644 index a11f88e35f..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActionGroupReceiver.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 9830CD16-D797-47EB-BEF5-6CFE3454BCAA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactiongroupreceiver -schema: 2.0.0 ---- - -# New-AzureRmActionGroupReceiver - -## SYNOPSIS -Creates an new action group receiver. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NewEmailReceiver (Default) -``` -New-AzureRmActionGroupReceiver -Name <String> [-EmailReceiver] -EmailAddress <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NewSmsReceiver -``` -New-AzureRmActionGroupReceiver -Name <String> [-SmsReceiver] [-CountryCode <String>] -PhoneNumber <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NewWebhookReceiver -``` -New-AzureRmActionGroupReceiver -Name <String> [-WebhookReceiver] -ServiceUri <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActionGroupReceiver** cmdlet creates new action group receiver in memory. - -## EXAMPLES - -### Example 1: Create a new Email receiver in memory. -``` -PS C:\>$emailReceiver = New-AzureRmActionGroupReceiver -Name 'emailReceiver1' -EmailReceiver -EmailAddress 'user1@example.com' -``` - -This command creates a new Email receiver in memory. - -### Example 2: Create a new SMS receiver in memory. -``` -PS C:\>$smsReceiver = New-AzureRmActionGroupReceiver -Name 'smsReceiver1' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' -``` - -This command creates a new SMS receiver in memory. - -### Example 3: Create a new webhook receiver in memory. -``` -PS C:\>$webhookReceiver = New-AzureRmActionGroupReceiver -Name 'webhookReceiver1' -SMSReceiver -ServiceUri 'http://test.com' -``` - -This command creates a new webhook receiver in memory. - -## PARAMETERS - -### -CountryCode -Specifies the country code for the SMS receiver. - -```yaml -Type: System.String -Parameter Sets: NewSmsReceiver -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the address for the Email receiver. - -```yaml -Type: System.String -Parameter Sets: NewEmailReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailReceiver -Specifies to create an Email receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewEmailReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the receiver. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PhoneNumber -Specifies the phone number for the SMS receiver. - -```yaml -Type: System.String -Parameter Sets: NewSmsReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the URI for the webhook receiver. - -```yaml -Type: System.String -Parameter Sets: NewWebhookReceiver -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SmsReceiver -Specifies to create a SMS receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewSmsReceiver -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebhookReceiver -Specifies to create a webhook receiver - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: NewWebhookReceiver -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActivityLogAlertCondition.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActivityLogAlertCondition.md deleted file mode 100644 index 9836cede79..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmActivityLogAlertCondition.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactivitylogalertcondition -schema: 2.0.0 ---- - -# New-AzureRmActivityLogAlertCondition - -## SYNOPSIS -Creates an new activity log alert condition object in memory. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmActivityLogAlertCondition -Field <String> -Equal <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmActivityLogAlertCondition** cmdlet creates new activity log alert condition object in memory. - -## EXAMPLES - -### Example 1: Create a new activity log alert condition object in memory. -``` -PS C:\>$condition = New-AzureRmActivityLogAlertCondition -Field "Requests" -Equal "OtherField" -``` - -This command creates a new activity log alert condition object in memory. -**NOTE**: when this cmdlet is used with Set-AzureRmActivityLogAlert at least one of these objects, passed as parameters, must have its Field equal to "Category". Otherwise, the backend responds with a 400 (BadRequest.) - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Equal -Specifies the equals property for the leaf condition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Field -Specifies the field for the condition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./Get-AzureRmActionGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleEmail.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleEmail.md deleted file mode 100644 index 00620d8a30..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleEmail.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B1000C10-265E-4465-B167-F1251470BE3E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermalertruleemail -schema: 2.0.0 ---- - -# New-AzureRmAlertRuleEmail - -## SYNOPSIS -Creates an email action for an alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAlertRuleEmail [[-CustomEmail] <String[]>] [-SendToServiceOwner] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAlertRuleEmail** cmdlet creates an e-mail action for an alert rule. - -## EXAMPLES - -### Example 1: Create an alert rule email action for service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -SendToServiceOwners -``` - -This command creates an alert rule email action to send for its service owners when an alert rule is fired. - -### Example 2: Create an alert rule email action for non-service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -CustomEmails pattif@contoso.com,davidchew@contoso.net -``` - -This command creates an alert rule email action for the specified email addresses, but not for the service owners. - -### Example 3: Create an alert rule email action for service owners and non-service owners -``` -PS C:\>New-AzureRmAlertRuleEmail -CustomEmails pattif@contoso.net -SendToServiceOwners -``` - -This command creates an alert rule email action for the specified address and for its service owners. - -## PARAMETERS - -### -CustomEmail -Specifies a list of comma-separated e-mail addresses. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendToServiceOwner -Indicates that this operation sends an e-mail to the service owners when the rule fires. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.RuleEmailAction - -## NOTES - -## RELATED LINKS - - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleWebhook.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleWebhook.md deleted file mode 100644 index 72b3d257fd..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAlertRuleWebhook.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 0137ECA3-37E1-4064-8A65-A582519E9017 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermalertrulewebhook -schema: 2.0.0 ---- - -# New-AzureRmAlertRuleWebhook - -## SYNOPSIS -Creates an alert rule webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAlertRuleWebhook [-ServiceUri] <String> [[-Property] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAlertRuleWebhook** cmdlet creates an alert rule webhook. - -## EXAMPLES - -### Example 1: Create an alert rule webhook -``` -PS C:\>New-AzureRmAlertRuleWebhook -ServiceUri "http://contoso.com" -``` - -This command creates an alert rule webhook by specifying only the service URI. - -### Example 2: Create a webhook with one property -``` -PS C:\>$Actual = New-AzureRmAlertRuleWebhook -ServiceUri "http://contoso.com" -Properties @{prop1 = 'value1'} -``` - -This command creates an alert rule webhook for Contoso.com that has one property, and then stores it in the $Actual variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies the list of properties in the format @(property1 = 'value1',....). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the service URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.RuleWebhookAction - -## NOTES - -## RELATED LINKS - - - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[New-AzureRmAlertRuleEmail](./New-AzureRmAlertRuleEmail.md) - -[New-AzureRmAutoscaleWebhook](./New-AzureRmAutoscaleWebhook.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleNotification.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleNotification.md deleted file mode 100644 index 254a0f45f4..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleNotification.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5B5F494-D912-40D0-99E2-A62FAACA3EC9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalenotification -schema: 2.0.0 ---- - -# New-AzureRmAutoscaleNotification - -## SYNOPSIS -Creates an Autoscale email notification. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleNotification [[-Webhook] <WebhookNotification[]>] [[-CustomEmail] <String[]>] - [-SendEmailToSubscriptionAdministrator] [-SendEmailToSubscriptionCoAdministrator] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleNotification** cmdlet creates an email notification for Autoscale. - -## EXAMPLES - -### Example 1: Create an Autoscale email notification -``` -PS C:\>New-AzureRmAutoscaleNotification -CustomEmails "pattif@contoso.com, davidchew@contoso.net" -``` - -This command creates an Autosacale email notification for two specified addresses. - -### Example 2: Create an Autoscale email notification for the subscription administrator -``` -PS C:\>New-AzureRmAutoscaleNotification -SendEmailToSubscriptionAdministrator -``` - -This command creates an Autosacale email notification for the subscription administrator. - -## PARAMETERS - -### -CustomEmail -Specifies a comma-separated list of email addresses. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToSubscriptionAdministrator -Indicates that this operation sends an email notification to the subscription administrator. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SendEmailToSubscriptionCoAdministrator -Indicates that this operation sends an email notification to the subscription co-administrators. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Webhook -Specifies a comma-separated list of Autoscale webhooks. - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification[] - -### System.String[] - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification - -## NOTES - -## RELATED LINKS - -[New-AzureRmAutoscaleWebhook](./New-AzureRmAutoscaleWebhook.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleProfile.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleProfile.md deleted file mode 100644 index 2d48336082..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleProfile.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscaleprofile -schema: 2.0.0 ---- - -# New-AzureRmAutoscaleProfile - -## SYNOPSIS -Creates an Autoscale profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### CreateWithoutScheduledTimes -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CreateWithFixedDateScheduling -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> -StartTimeWindow <DateTime> -EndTimeWindow <DateTime> -TimeWindowTimeZone <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CreateUsingRecurrentScheduling -``` -New-AzureRmAutoscaleProfile -Name <String> -DefaultCapacity <String> -MaximumCapacity <String> - -MinimumCapacity <String> -RecurrenceFrequency <RecurrenceFrequency> - -ScheduleDay <System.Collections.Generic.List`1[System.String]> - -ScheduleHour <System.Collections.Generic.List`1[System.Nullable`1[System.Int32]]> - -ScheduleMinute <System.Collections.Generic.List`1[System.Nullable`1[System.Int32]]> - -ScheduleTimeZone <String> - -Rule <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleProfile** cmdlet creates an Autoscale profile. - -## EXAMPLES - -### Example 1: Create single profile with a fixed date -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rule $Rule -Name "Profile01" -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : Microsoft.Azure.Management.Insights.Models.TimeWindow -Name : adios -Recurrence : -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile named Profile01 with a fixed date using the rule in $Rule. - -### Example 2: Create a profile with a schedule -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule -Name "SecondProfileName" -RecurrenceFrequency Minute -ScheduleDays "1", "2", "3" -ScheduleHours 5, 10, 15 -ScheduleMinutes 15, 30, 45 -ScheduleTimeZone GMT -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : -Name : secondProfileName -Recurrence : Microsoft.Azure.Management.Insights.Models.Recurrence -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile named SecondProfileName with a recurring schedule using the rule in $Rule. - -### Example 3: Create profiles with two rules -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" - -PS C:\> $Profile1 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -StartTimeWindow 2015-03-05T14:00:00 -EndTimeWindow 2015-03-05T14:30:00 -TimeWindowTimeZone GMT -Rule $Rule1, $Rule2 -Name "ProfileName" - -PS C:\> $Profile2 = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule1, $Rule2 -Name "SecondProfileName" -RecurrenceFrequency Week -ScheduleDays "1" -ScheduleHours 5 -ScheduleMinutes 15 -ScheduleTimeZone UTC -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : Microsoft.Azure.Management.Insights.Models.TimeWindow -Name : profileName -Recurrence : -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -Capacity : Microsoft.Azure.Management.Insights.Models.ScaleCapacity -FixedDate : -Name : secondProfileName -Recurrence : Microsoft.Azure.Management.Insights.Models.Recurrence -Rules : {Microsoft.Azure.Management.Insights.Models.ScaleRule, - Microsoft.Azure.Management.Insights.Models.ScaleRule} -``` - -The first two commands create rules, and store them in the variables $Rule1 and $Rule2, respectively. -The third command creates a profile named ProfileName using the rules in Rule1 and Rule2, and then stores it in the $Profile1 variable. -The final command creates a profile named SecondProfileName using the rules in Rule1 and Rule2, and then stores it in the $Profile2 variable. - -### Example 4: Create a profile with no schedule or fixed date -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Profile = New-AzureRmAutoscaleProfile -DefaultCapacity "1" -MaximumCapacity "10" -MinimumCapacity "1" -Rule $Rule -Name "ProfileName" -``` - -The first command creates an Autoscale rule named Requests, and then stores it in the $Rule variable. -The second command creates a profile without a schedule or a fixed date, and then stores it in the $Profile variable. - -## PARAMETERS - -### -DefaultCapacity -Specifies the default capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTimeWindow -Specifies the end of the time window. - -```yaml -Type: System.DateTime -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaximumCapacity -Specifies the maximum capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumCapacity -Specifies the minimum capacity. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the profile to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecurrenceFrequency -Specifies the frequency of recurrence. -The acceptable values for this parameter are: -- None -- Second -- Minute -- Hour -- Day -- Week -- Month -- Year -Not all of these values are supported. - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.RecurrenceFrequency -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: -Accepted values: None, Second, Minute, Hour, Day, Week, Month, Year - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rule -Specifies the list of rules to add to the profile. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleDay -Specifies the scheduled days. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleHour -Specifies the scheduled hours. - -```yaml -Type: System.Collections.Generic.List`1[System.Nullable`1[System.Int32]] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleMinute -Specifies the scheduled minutes. - -```yaml -Type: System.Collections.Generic.List`1[System.Nullable`1[System.Int32]] -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleTimeZone -Specifies the time zone of the schedule. - -```yaml -Type: System.String -Parameter Sets: CreateUsingRecurrentScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTimeWindow -Specifies the start of the time window. - -```yaml -Type: System.DateTime -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeWindowTimeZone -Specifies the time zone of the time window. - -```yaml -Type: System.String -Parameter Sets: CreateWithFixedDateScheduling -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.DateTime - -### Microsoft.Azure.Management.Monitor.Management.Models.RecurrenceFrequency - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleHistory](./Get-AzureRmAutoscaleHistory.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleRule](./New-AzureRmAutoscaleRule.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleRule.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleRule.md deleted file mode 100644 index 34cc37eced..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleRule.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalerule -schema: 2.0.0 ---- - -# New-AzureRmAutoscaleRule - -## SYNOPSIS -Creates an Autoscale rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleRule -MetricName <String> -MetricResourceId <String> -Operator <ComparisonOperationType> - -MetricStatistic <MetricStatisticType> -Threshold <Double> [-TimeAggregationOperator <TimeAggregationType>] - -TimeGrain <TimeSpan> [-TimeWindow <TimeSpan>] -ScaleActionCooldown <TimeSpan> - -ScaleActionDirection <ScaleDirection> [-ScaleActionScaleType <ScaleType>] -ScaleActionValue <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleRule** cmdlet creates an Autoscale rule. - -## EXAMPLES - -### Example 1: Create a rule -``` -PS C:\>$Rule = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" -MetricTrigger ScaleAction -------------- ----------- -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -``` - -This command creates a rule. - -### Example 2: Create two rules -``` -PS C:\>$Rule1 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:05:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "1" - -PS C:\> $Rule2 = New-AzureRmAutoscaleRule -MetricName "Requests" -MetricResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -Operator GreaterThan -MetricStatistic Average -Threshold 10 -TimeGrain 00:01:00 -ScaleActionCooldown 00:10:00 -ScaleActionDirection Increase -ScaleActionScaleType ChangeCount -ScaleActionValue "2" -MetricTrigger ScaleAction -------------- ----------- -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -Microsoft.Azure.Management.Insights.Models.MetricTrigger Microsoft.Azure.Management.Insights.Models.ScaleAction -``` - -The first command creates a rule for the Requests metric, and then stores it in the $Rule1 variable. -The second command creates a second rule for the Requests metric, and then stores it in the $Rule2 variable. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetricName -Specifies the name of the metric. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricResourceId -Specifies the metric resource ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MetricStatistic -Specifies the metric statistic. -The acceptable values for this parameter are: -- Average -- Min -- Max -- Sum - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.MetricStatisticType -Parameter Sets: (All) -Aliases: -Accepted values: Average, Min, Max, Sum - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the operator. -The acceptable values for this parameter are: -- Equals -- NotEquals -- GreaterThan -- GreaterThanOrEqual -- LessThan -- LessThanOrEqual - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ComparisonOperationType -Parameter Sets: (All) -Aliases: -Accepted values: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionCooldown -Specifies the Autoscale action cooldown time. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionDirection -Specifies the scale action direction. -The acceptable values for this parameter are: -- None -- Increase -- Decrease - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ScaleDirection -Parameter Sets: (All) -Aliases: -Accepted values: None, Increase, Decrease - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionScaleType -Specifies the scale type. -The acceptable values for this parameter are: -- ChangeSize -- ChangeCount -- PercentChangeCount -- ExactCount - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.ScaleType -Parameter Sets: (All) -Aliases: -Accepted values: ChangeCount, PercentChangeCount, ExactCount - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScaleActionValue -Specifies the action value. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies the threshold of the metric value. - -```yaml -Type: System.Double -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeAggregationOperator -Specifies the time aggregation operator. -The acceptable values for this parameter are: -- Average -- Minimum -- Maximum -- Last -- Total, Count - -```yaml -Type: Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationType -Parameter Sets: (All) -Aliases: -Accepted values: Average, Minimum, Maximum, Total, Count - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeGrain -Specifies the time grain. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeWindow -Specifies the time window. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Management.Monitor.Management.Models.ComparisonOperationType - -### Microsoft.Azure.Management.Monitor.Management.Models.MetricStatisticType - -### System.Double - -### Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationType - -### System.TimeSpan - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleDirection - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleType - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleHistory](./Get-AzureRmAutoscaleHistory.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - -[New-AzureRmAutoscaleProfile](./New-AzureRmAutoscaleProfile.md) - -[Remove-AzureRmAutoscaleSetting](./Remove-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleWebhook.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleWebhook.md deleted file mode 100644 index d0b232d0f6..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmAutoscaleWebhook.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 674A11E4-36B9-4075-9F4E-952BD9FF07A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermautoscalewebhook -schema: 2.0.0 ---- - -# New-AzureRmAutoscaleWebhook - -## SYNOPSIS -Creates an Autoscale webhook. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmAutoscaleWebhook [-ServiceUri] <String> [[-Property] <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAutoscaleWebhook** cmdlet creates an Autoscale webhook. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies the list of properties in the format @(property1 = 'value1',....). - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceUri -Specifies the service URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Management.Monitor.Management.Models.WebhookNotification - -## NOTES - -## RELATED LINKS - -[New-AzureRmAlertRuleWebhook](./New-AzureRmAlertRuleWebhook.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmMetricFilter.md b/azurermps-2.5.0/AzureRm.Insights/New-AzureRmMetricFilter.md deleted file mode 100644 index 707e77193f..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/New-AzureRmMetricFilter.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermmetricfilter -schema: 2.0.0 ---- - -# New-AzureRmMetricFilter - -## SYNOPSIS -Creates a metric dimension filter that can be used to query metrics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmMetricFilter [-Dimension] <String> [-Operator] <String> [-Value] <String[]> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmMetricFilter** cmdlet creates a metric dimension filter that can be used to query metrics. - -## EXAMPLES - -### Example 1: Create a metric dimension filter -``` -PS C:\>New-AzureRmMetricFilter -Dimension City -Operator eq -Value "Seattle","New York" -``` - -This command creates metric dimension filter of the format "City eq 'Seattle' or City eq 'New York'". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dimension -The name of the metric dimension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Operator -Specifies the operator used to select the metric dimension. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the array of metric dimension values. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmMetric](./Get-AzureRmMetric.md) -[Get-AzureRmMetricDefinition](./Get-AzureRmMetricDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActionGroup.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActionGroup.md deleted file mode 100644 index cbfe960e92..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActionGroup.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 8D8FE2FE-03E7-453E-B968-E28B07E42EF2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermactiongroup -schema: 2.0.0 ---- - -# Remove-AzureRmActionGroup - -## SYNOPSIS -Removes an action group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByPropertyName (Default) -``` -Remove-AzureRmActionGroup -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Remove-AzureRmActionGroup -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Remove-AzureRmActionGroup -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmActionGroup** cmdlet removes an action group. - -## EXAMPLES - -### Example 1: Remove an action group -``` -PS C:\>Remove-AzureRmActionGroup -ResourceGroup "Default-Web-CentralUS" -Name "myActionGroup" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The action group resourc - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group nam - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource i - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Set-AzureRmActionGroup](./Set-AzureRmActionGroup.md) -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActivityLogAlert.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActivityLogAlert.md deleted file mode 100644 index 37df6e629e..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermactivitylogalert -schema: 2.0.0 ---- - -# Remove-AzureRmActivityLogAlert - -## SYNOPSIS -Removes an activity log alert. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup -``` -Remove-AzureRmActivityLogAlert -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObject -``` -Remove-AzureRmActivityLogAlert -InputObject <PSActivityLogAlertResource> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceId -``` -Remove-AzureRmActivityLogAlert -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmActivityLogAlert** cmdlet removes an activity log alert. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually patching the resource. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove an activity log alert -``` -PS C:\>Remove-AzureRmActivityLogAlert -ResourceGroup "Default-Web-CentralUS" -Name "myalert" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -Removes an activity log alert using name and resource group name as inputs. - -### Example 2: Remove an activity log alert using a PSActivityLogAlertResource as input -``` -PS C:\>Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" | Remove-AzureRmActivityLogAlert -RequestId StatusCode ---------- ---------- -5c371547-80b0-4185-9b95-700b129de9d4 OK -``` - -Removes an activity log alert using a PSActivityLogAlertResource as input. - -### Example 3: Remove the ActivityLogAlert using the ResourceId parameter -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Remove-AzureRmActivityLogAlert -``` - -This command removes the ActivityLogAlert using the ResourceId parameter from the pipe. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: RemoveByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource exists. - -```yaml -Type: System.String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Set-AzureRmActivityLogAlert](./Set-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAlertRule.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAlertRule.md deleted file mode 100644 index bb8796b214..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAlertRule.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermalertrule -schema: 2.0.0 ---- - -# Remove-AzureRmAlertRule - -## SYNOPSIS -Removes an alert rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAlertRule -ResourceGroupName <String> -Name <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAlertRule** cmdlet removes an alert rule. -You must specify the name of the alert rule and the resource group to which it is assigned. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove an alert rule -``` -PS C:\>Remove-AzureRmAlertRule -ResourceGroup "Default-Web-CentralUS" -Name "myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8" -RequestId StatusCode ---------- ---------- -2c6c159b-0e73-4a01-a67b-c32c1a0008a3 OK -``` - -This command removes the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb8f0ac8 in the resource group Default-Web-CentralUS. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 alert rule to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the alert rule. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmMetricAlertRule](./Add-AzureRmMetricAlertRule.md) - -[Add-AzureRmWebtestAlertRule](./Add-AzureRmWebtestAlertRule.md) - -[Get-AzureRmAlertHistory](./Get-AzureRmAlertHistory.md) - -[Get-AzureRmAlertRule](./Get-AzureRmAlertRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAutoscaleSetting.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAutoscaleSetting.md deleted file mode 100644 index bb3ee44254..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmAutoscaleSetting.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 6140E973-D7AB-4A28-A4FA-818E08129372 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermautoscalesetting -schema: 2.0.0 ---- - -# Remove-AzureRmAutoscaleSetting - -## SYNOPSIS -Removes an Autoscale setting. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmAutoscaleSetting -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAutoscaleSetting** cmdlet removes an Autoscale setting. -You must specify the name of the setting and the name of the resource group to which it is assigned. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Autoscale setting to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmAutoscaleSetting](./Add-AzureRmAutoscaleSetting.md) - -[Get-AzureRmAutoscaleSetting](./Get-AzureRmAutoscaleSetting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmDiagnosticSetting.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmDiagnosticSetting.md deleted file mode 100644 index e787bc09c1..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermdiagnosticsetting -schema: 2.0.0 ---- - -# Remove-AzureRmDiagnosticSetting - -## SYNOPSIS -Remove a diagnostic setting for the a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmDiagnosticSetting -ResourceId <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDiagnosticSetting** cmdlet removes the diagnostic setting for the particular resource. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Remove the default diagnostic setting (service) for a resource -``` -PS C:\>Remove-AzureRmDiagnosticSetting -ResourceId "Resource01" -``` - -This command removes the default diagnostic setting (service) for the resource called Resource01. - -### Example 2: Remove the default diagnostic setting identified by the given name for a resource -``` -PS C:\>Remove-AzureRmDiagnosticSetting -ResourceId "Resource01" -Name myDiagSetting -``` - -This command removes the diagnostic setting called myDiagSetting for the resource called Resource01. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. If not given the call default to "service" as it was in the previous API and this cmdlet will only disable all categories for metrics/logs. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDiagnosticSetting](./Get-AzureRmDiagnosticSetting.md) -[Set-AzureRmDiagnosticSetting](./Set-AzureRmDiagnosticSetting.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmLogProfile.md b/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmLogProfile.md deleted file mode 100644 index 8b48f5f139..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Remove-AzureRmLogProfile.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: DDA137FD-4EB3-4FB7-A202-978922038AFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/remove-azurermlogprofile -schema: 2.0.0 ---- - -# Remove-AzureRmLogProfile - -## SYNOPSIS -Removes a log profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLogProfile -Name <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLogProfile** cmdlet removes a log profile. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 log profile to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLogProfile](./Add-AzureRmLogProfile.md) - -[Get-AzureRmLogProfile](./Get-AzureRmLogProfile.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActionGroup.md b/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActionGroup.md deleted file mode 100644 index 644ae2f888..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActionGroup.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 4A6816DB-0E46-44F0-8AE9-180B1C4AAB22 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermactiongroup -schema: 2.0.0 ---- - -# Set-AzureRmActionGroup - -## SYNOPSIS -Creates a new or updates an existing action group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByPropertyName (Default) -``` -Set-AzureRmActionGroup -ResourceGroupName <String> -Name <String> -ShortName <String> - -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> - [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceId -``` -Set-AzureRmActionGroup -ShortName <String> - -Receiver <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase]> - [-DisableGroup] [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByInputObject -``` -Set-AzureRmActionGroup [-ShortName <String>] [-DisableGroup] - [-Tag <System.Collections.Generic.IDictionary`2[System.String,System.String]>] - -InputObject <PSActionGroupResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmActionGroup** cmdlet creates a new or updates an existing action group - -## EXAMPLES - -### Example 1: Create an Action Group -``` -PS C:\>$email1 = New-AzureRmActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'user1@example.com' -PS C:\>$sms1 = New-AzureRmActionGroupReceiver -Name 'user2' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' -PS C:\>Set-AzureRmActionGroup -Name $actionGroupName -ResourceGroup $resourceGroupName -ShortName $shortName -Receiver $email1,$sms1 -``` - -The first two commands create two receivers. -The final command creates an Action Group including the two receivers. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableGroup -Disables the action group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The action group resourc - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Receiver -The list of receivers of the action group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase] -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group nam - -```yaml -Type: System.String -Parameter Sets: ByPropertyName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -The resource i - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShortName -The short name of the action group. - -```yaml -Type: System.String -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -The tags of the action group resourc - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: ByPropertyName, ByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.IDictionary`2[System.String,System.String] -Parameter Sets: ByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Management.Automation.SwitchParameter - -### System.Collections.Generic.IDictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupResource - -## NOTES - -## RELATED LINKS - -[Get-AzureRmActionGroup](./Get-AzureRmActionGroup.md) -[Remove-AzureRmActionGroup](./Remove-AzureRmActionGroup.md) -[New-AzureRmActionGroupReceiver](./New-AzureRmActionGroupReceiver.md) diff --git a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActivityLogAlert.md b/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActivityLogAlert.md deleted file mode 100644 index bf885227c5..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmActivityLogAlert.md +++ /dev/null @@ -1,465 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermactivitylogalert -schema: 2.0.0 ---- - -# Set-AzureRmActivityLogAlert - -## SYNOPSIS -Creates a new or sets an existing activity log alert. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup -``` -Set-AzureRmActivityLogAlert -Location <String> -Name <String> -ResourceGroupName <String> - -Scope <System.Collections.Generic.List`1[System.String]> - -Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]> - -Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]> - [-DisableAlert] [-Description <String>] - [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmActivityLogAlert [-Location <String>] [-Scope <System.Collections.Generic.List`1[System.String]>] - [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>] - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>] - [-DisableAlert] [-Description <String>] - [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] -ResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByInputObject -``` -Set-AzureRmActivityLogAlert [-Scope <System.Collections.Generic.List`1[System.String]>] - [-Condition <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition]>] - [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup]>] - [-Description <String>] [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>] - -InputObject <PSActivityLogAlertResource> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmActivityLogAlert** cmdlet creates a new or sets an existing activity log alert. -For tags, conditions, and actions the objects must be created in advance and passed as parameters in this call as a comma separated (see the example below). -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating/modifying the resource. -**NOTE**: This cmdlet and its related ones replaces the deprecated (November 2017) **Add-AzureRmLogAlertRule**. - -## EXAMPLES - -### Example 1: Create an Activity Log Alert -``` -PS C:\>$location = 'Global' -PS C:\>$alertName = 'myAlert' -PS C:\>$resourceGroupName = 'theResourceGroupName' -PS C:\>$condition1 = New-AzureRmActivityLogAlertCondition -Field 'field1' -Equals 'equals1' -PS C:\>$condition2 = New-AzureRmActivityLogAlertCondition -Field 'field2' -Equals 'equals2' -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -``` - -The first four commands create leaf condition and action group. -The final command creates an Activity Log Alert using the condition and the action group. - -### Example 2: Create an Activity Log Alert disabled -``` -PS C:\>$location = 'Global' -PS C:\>$alertName = 'myAlert' -PS C:\>$resourceGroupName = 'theResourceGroupName' -PS C:\>$condition1 = New-AzureRmActivityLogAlertCondition -Field 'field1' -Equals 'equals1' -PS C:\>$condition2 = New-AzureRmActivityLogAlertCondition -Field 'field2' -Equals 'equals2' -PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]" -PS C:\>$dict.Add('key1', 'value1') -PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict -PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -DisableAlert -``` - -The first four commands create leaf condition and action group. -The final command creates an Activity Log Alert using the condition and the action group, but it creates the alert disabled. - -### Example 3: Set an activity log alert based using a value from the pipe or the InputObject parameter -``` -PS C:\>Get-AzureRmActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName | Set-AzureRmActivityLogAlert -PS C:\>$alert = Get-AzureRmActivityLogAlert -Name $alertName -ResourceGroupName $resourceGroupName -PS C:\>$alert.Description = 'Changing the description' -PS C:\>$alert.Enabled = $false -PS C:\>Set-AzureRmActivityLogAlert -InputObject $alert -``` - -The first command is similar to a nop, it sets the alert with the same values it already contained -The rest of the commands retrieve the alert rule, change the description and disable it, then use the InputObject parameter to persist those changes - -### Example 4: Set an activity log alert based using the ResourceId value from the pipe -``` -PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Set-AzureRmActivityLogAlert -DisableAlert -``` - -If the given log alert rule exists this command disables it. - -## PARAMETERS - -### -Action -The list of action groups for the activity log alert. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Condition -The list of conditions for the activity log alert. -**NOTE**: In the list of conditions there must be at least one with the Field equal to "Category". The backend responds with 400 (BadRequest) if this condition is not present. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] -Parameter Sets: SetByInputObject -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 of the alert resource. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableAlert -Allows the user to create a disabled the activity log alert. If not given, the alerts are created enabled. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The location where the activity log alert will exist. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the activity log alert. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. - -```yaml -Type: System.String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Sets the ResourceId tags property of the call to extract the required name, resource group name properties. - -```yaml -Type: System.String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The list of scopes for the activity log alert. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Sets the tags property of the activity log alert resource. - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: SetByNameAndResourceGroup, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Collections.Generic.Dictionary`2[System.String,System.String] -Parameter Sets: SetByInputObject -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.List`1[[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup, Microsoft.Azure.Commands.Insights, Version=5.1.0.0, Culture=neutral, PublicKeyToken=null]] - -### System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource - -## NOTES - -## RELATED LINKS - -[Enable-AzureRmActivityLogAlert](./Enable-AzureRmActivityLogAlert.md) - -[Disable-AzureRmActivityLogAlert](./Disable-AzureRmActivityLogAlert.md) - -[Get-AzureRmActivityLogAlert](./Get-AzureRmActivityLogAlert.md) - -[Remove-AzureRmActivityLogAlert](./Remove-AzureRmActivityLogAlert.md) - -[New-AzureRmActionGroup](./New-AzureRmActionGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmDiagnosticSetting.md b/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmDiagnosticSetting.md deleted file mode 100644 index 49941d4ac5..0000000000 --- a/azurermps-2.5.0/AzureRm.Insights/Set-AzureRmDiagnosticSetting.md +++ /dev/null @@ -1,417 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml -Module Name: AzureRM.Insights -ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermdiagnosticsetting -schema: 2.0.0 ---- - -# Set-AzureRmDiagnosticSetting - -## SYNOPSIS -Sets the logs and metrics settings for the resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### OldSetDiagnosticSetting (Default) -``` -Set-AzureRmDiagnosticSetting -ResourceId <String> [-Name <String>] [-StorageAccountId <String>] - [-ServiceBusRuleId <String>] [-EventHubName <String>] [-EventHubAuthorizationRuleId <String>] - [-Enabled <Boolean>] [-Categories <System.Collections.Generic.List`1[System.String]>] - [-MetricCategory <System.Collections.Generic.List`1[System.String]>] - [-Timegrains <System.Collections.Generic.List`1[System.String]>] [-RetentionEnabled <Boolean>] - [-WorkspaceId <String>] [-RetentionInDays <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### NewSetDiagnosticSetting -``` -Set-AzureRmDiagnosticSetting -InputObject <PSServiceDiagnosticSettings> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmDiagnosticSetting** cmdlet enables or disables each time grain and log category for the particular resource. -The logs and metrics are stored in the specified storage account. -This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource. - -## EXAMPLES - -### Example 1: Enable all metrics and logs for a resource -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -``` - -This command enables all available metrics and logs for Resource01. - -### Example 2: Disable all metrics and logs -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $False -``` - -This command disables all available metrics and logs for the resource Resource01. - -### Example 3: Enable/disable multiple metrics categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $False -MetricCategory MetricCategory1,MetricCategory2 -StorageAccountId : <storageAccountId> -StorageAccountName : <storageAccountName> -Metrics - Enabled : False - Category : MetricCategory1 - Timegrain : PT1M - Enabled : False - Category : MetricCategory2 - Timegrain : PT1H - Enabled : True - Category : MetricCategory3 - Timegrain : PT1H -Logs - Enabled : True - Category : Category1 - Enabled : True - Category : Category2 - Enabled : True - Category : Category3 - Enabled : False - Category : Category4 -``` - -This command enables the metrics cateories called Category1 and Category2. -All the other categories remain the same. - -### Example 4: Enable/disable multiple log categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories Category1,Category2 -StorageAccountId : <storageAccountId> -StorageAccountName : <storageAccountName> -Metrics - Enabled : False - Category : MetricCategory1 - Timegrain : PT1M - Enabled : False - Category : MetricCategory2 - Timegrain : PT1H - Enabled : True - Category : MetricCategory3 - Timegrain : PT1H -Logs - Enabled : True - Category : Category1 - Enabled : True - Category : Category2 - Enabled : True - Category : Category3 - Enabled : False - Category : Category4 -``` - -This command enables Category1 and Category2. -All the other metrics and logs categories remain the same. - -### Example 4: Enable a time grain and multiple categories -``` -PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories Category1,Category2 -Timegrains PT1M -``` - -This command enables only Category1, Category2, and time grain PT1M. -All other time grains and categories are unchanged. - -### Example 5: Using pipeline -``` -PS C:\>Get-AzureRmDiagnosticSetting -ResourceId "Resource01" | Set-AzureRmDiagnosticSetting -``` - -This command uses the PowerShell pipeline to set (not change made) a diagnostic setting. - -## PARAMETERS - -### -Categories -Specifies the list of log categories to enable or disable, according to the value of *Enabled*. -If no category is specified, this command operates on all supported categories. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: Category - -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether to enable diagnostics. -Specify $True to enable diagnostics, or $False to disable diagnostics. - -```yaml -Type: System.Boolean -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventHubAuthorizationRuleId -The event hub authorization rule id - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventHubName -The event hub name - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The input object (possible from the pipeline.) The name and resourceId will be extracted from this object. - -```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings -Parameter Sets: NewSetDiagnosticSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MetricCategory -The list of metric categories. -If no category is specified, this command operates on all supported categories. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the diagnostic setting. The default value is **service**. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the ID of the resource. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionEnabled -Indicates whether retention of diagnostic information is enabled. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Specifies the retention policy, in days. - -```yaml -Type: System.Nullable`1[System.Int32] -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceBusRuleId -The Service Bus Rule id. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Specifies the ID of the Storage account in which to save the data. - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Timegrains -Specifies the time grains to enable or disable for metrics, according to the value of *Enabled*. -If you do not specify a time grain, this command operates on all available time grains. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: OldSetDiagnosticSetting -Aliases: Timegrain - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkspaceId -The Id of the workspace - -```yaml -Type: System.String -Parameter Sets: OldSetDiagnosticSetting -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings -Parameters: InputObject (ByValue) - -### System.String - -### System.Boolean - -### System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Insights.OutputClasses.PSServiceDiagnosticSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmDiagnosticSetting](./Get-AzureRmDiagnosticSetting.md) -[Remove-AzureRmDiagnosticSetting](./Remove-AzureRmDiagnosticSetting.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificate.md b/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificate.md deleted file mode 100644 index bcfc767c4f..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 89299823-3382-402D-9458-519466748051 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultcertificate -schema: 2.0.0 ---- - -# Add-AzureKeyVaultCertificate - -## SYNOPSIS -Adds a certificate to a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> - [[-CertificatePolicy] <KeyVaultCertificatePolicy>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultCertificate** cmdlet starts the process of enrolling for a certificate in a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Add a certificate -``` -PS C:\>$Policy = New-AzureKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal -PS C:\> Add-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -CertificatePolicy $Policy - -Status : inProgress -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : PS C:\>Get-AzureKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Status : completed -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : PS C:\>Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Name : testCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - 05979C5A2F0741D5A3B6F97673E8A118 - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - 3E9B6848AD1834284157D68B060F748037F663C8 - -Thumbprint : 3E9B6848AD1834284157D68B060F748037F663C8 -Tags : -Enabled : True -Created : 2/8/2016 11:21:45 PM -Updated : 2/8/2016 11:21:45 PM -``` - -The first command uses the New-AzureKeyVaultCertificatePolicy cmdlet to create a certificate policy, and then stores it in the $Policy variable. - -The second command uses **Add-AzureKeyVaultCertificate** to start the process to create a certificate. - -The third command uses the Get-AzureKeyVaultCertificateOperation cmdlet to poll the operation to verify that it's complete. - -The final command uses the Get-AzureKeyVaultCertificate cmdlet to get the certificate. - -## PARAMETERS - -### -CertificatePolicy -Specifies a **KeyVaultCertificatePolicy** object. - -```yaml -Type: KeyVaultCertificatePolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -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 certificate to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificateContact.md b/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificateContact.md deleted file mode 100644 index 69d371cc76..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultcertificatecontact -schema: 2.0.0 ---- - -# Add-AzureKeyVaultCertificateContact - -## SYNOPSIS -Adds a contact for certificate notifications. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultCertificateContact** cmdlet adds a contact for a key vault for certificate notifications in Azure Key Vault. -The contact receives updates about events such as certificate close to expiry, certificate renewed, and so on. -These events are determined by the certificate policy. - -## EXAMPLES - -### Example 1: Add a key vault certificate contact -``` -PS C:\>Add-AzureKeyVaultCertificateContact -VaultName "ContosoKV01" -EmailAddress "patti.fuller@contoso.com" -PassThru -``` - -This command adds Patti Fuller as a certificate contact for the ContosoKV01 key vault and returns the **KeyVaultCertificateContact** object. - -## 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 -``` - -### -EmailAddress -Specifies the email address of the contact. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### List<Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateContact> - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateContact](./Get-AzureKeyVaultCertificateContact.md) - -[Remove-AzureKeyVaultCertificateContact](./Remove-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultKey.md deleted file mode 100644 index 2517ec0e34..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultKey.md +++ /dev/null @@ -1,427 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultkey -schema: 2.0.0 ---- - -# Add-AzureKeyVaultKey - -## SYNOPSIS -Creates a key in a key vault or imports a key into a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Create (Default) -``` -Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -Destination <String> [-Disable] - [-KeyOps <String[]>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### Import -``` -Add-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> -KeyFilePath <String> - [-KeyFilePassword <SecureString>] [-Destination <String>] [-Disable] [-KeyOps <String[]>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureKeyVaultKey** cmdlet creates a key in a key vault in Azure Key Vault, or imports a key into a key vault. -Use this cmdlet to add keys by using any of the following methods: - -- Create a key in a hardware security module (HSM) in the Key Vault service. -- Create a key in software in the Key Vault service. -- Import a key from your own hardware security module (HSM) to HSMs in the Key Vault service. -- Import a key from a .pfx file on your computer. -- Import a key from a .pfx file on your computer to hardware security modules (HSMs) in the Key Vault service. - -For any of these operations, you can provide key attributes or accept default settings. - -If you create or import a key that has the same name as an existing key in your key vault, the -original key is updated with the values that you specify for the new key. You can access the -previous values by using the version-specific URI for that version of the key. To learn about key -versions and the URI structure, see [About Keys andSecrets](https://go.microsoft.com/fwlink/?linkid=518560) -in the Key Vault REST API documentation. - -Note: To import a key from your own hardware security module, you must first generate a BYOK -package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. For -more information, see -[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](https://go.microsoft.com/fwlink/?LinkId=522252). - -As a best practice, back up your key after it is created or updated, by using the -Backup-AzureKeyVaultKey cmdlet. There is no undelete functionality, so if you accidentally delete -your key or delete it and then change your mind, the key is not recoverable unless you have a -backup of it that you can restore. - -## EXAMPLES - -### Example 1: Create a key -``` -PS C:\>Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Destination 'Software' -``` - -This command creates a software-protected key named ITSoftware in the key vault named Contoso. - -### Example 2: Create an HSM-protected key -``` -PS C:\>Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITHsm' -Destination 'HSM' -``` - -This command creates an HSM-protected key in the key vault named Contoso. - -### Example 3: Create a key with non-default values -``` -PS C:\>$KeyOperations = 'decrypt', 'verify' -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $NotBefore = (Get-Date).ToUniversalTime() -PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = null} -PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITHsmNonDefault' -Destination 'HSM' -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations -Disable -Tag $Tags -``` - -The first command stores the values decrypt and verify in the $KeyOperations variable. - -The second command creates a **DateTime** object, defined in UTC, by using the **Get-Date** cmdlet. -That object specifies a time two years in the future. The command stores that date in the $Expires -variable. For more information, type `Get-Help Get-Date`. - -The third command creates a **DateTime** object by using the **Get-Date** cmdlet. That object -specifies current UTC time. The command stores that date in the $NotBefore variable. - -The final command creates a key named ITHsmNonDefault that is an HSM-protected key. The command -specifies values for allowed key operations stored $KeyOperations. The command specifies times for -the *Expires* and *NotBefore* parameters created in the previous commands, and tags for high -severity and IT. The new key is disabled. You can enable it by using the **Set-AzureKeyVaultKey** -cmdlet. - -### Example 4: Import an HSM-protected key -``` -PS C:\>Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITByok' -KeyFilePath 'C:\Contoso\ITByok.byok' -Destination 'HSM' -``` - -This command imports the key named ITByok from the location that the *KeyFilePath* parameter -specifies. The imported key is an HSM-protected key. - -To import a key from your own hardware security module, you must first generate a BYOK package (a file with a .byok file name extension) by using the Azure Key Vault BYOK toolset. -For more information, see -[How to Generate and Transfer HSM-Protected Keys for Azure Key Vault](https://go.microsoft.com/fwlink/?LinkId=522252). - -### Example 5: Import a software-protected key -``` -PS C:\>$Password = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITPfx' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Password variable. For more information, type `Get-Help -ConvertTo-SecureString`. - -The second command creates a software password in the Contoso key vault. The command specifies the -location for the key and the password stored in $Password. - -### Example 6: Import a key and assign attributes -``` -PS C:\>$Password = ConvertTo-SecureString -String 'password' -AsPlainText -Force -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'high'; 'Accounting' = null } -PS C:\> Add-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITPfxToHSM' -Destination 'HSM' -KeyFilePath 'C:\Contoso\ITPfx.pfx' -KeyFilePassword $Password -Expires $Expires -Tag $Tags -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Password variable. - -The second command creates a **DateTime** object by using the **Get-Date** cmdlet, and then stores -that object in the $Expires variable. - -The third command creates the $tags variable to set tags for high severity and IT. - -The final command imports a key as an HSM key from the specified location. The command specifies -the expiration time stored in $Expires and password stored in $Password, and applies the tags -stored in $tags. - -## 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 -``` - -### -Destination -Specifies whether to add the key as a software-protected key or an HSM-protected key in the Key Vault service. -Valid values are: HSM and Software. - -Note: To use HSM as your destination, you must have a key vault that supports HSMs. For more -information about the service tiers and capabilities for Azure Key Vault, see the -[Azure Key Vault Pricing website](https://go.microsoft.com/fwlink/?linkid=512521). - -This parameter is required when you create a new key. If you import a key by using the -*KeyFilePath* parameter, this parameter is optional: - -- If you do not specify this parameter, and this cmdlet imports a key that has .byok file name -extension, it imports that key as an HSM-protected key. The cmdlet cannot import that key as -software-protected key. - -- If you do not specify this parameter, and this cmdlet imports a key that has a .pfx file name -extension, it imports the key as a software-protected key. - -```yaml -Type: String -Parameter Sets: Create -Aliases: -Accepted values: HSM, Software - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Import -Aliases: -Accepted values: HSM, Software - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that the key you are adding is set to an initial state of disabled. Any attempt to use -the key will fail. Use this parameter if you are preloading keys that you intend to enable later. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet adds. This -parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the -**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. If you do not specify this -parameter, the key does not expire. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyFilePassword -Specifies a password for the imported file as a **SecureString** object. To obtain a -**SecureString** object, use the **ConvertTo-SecureString** cmdlet. For more information, type -`Get-Help ConvertTo-SecureString`. You must specify this password to import a file with a .pfx file -name extension. - -```yaml -Type: SecureString -Parameter Sets: Import -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyFilePath -Specifies the path of a local file that contains key material that this cmdlet imports. -The valid file name extensions are .byok and .pfx. - -- If the file is a .byok file, the key is automatically protected by HSMs after the import and you -cannot override this default. - -- If the file is a .pfx file, the key is automatically protected by software after the import. To -override this default, set the *Destination* parameter to HSM so that the key is HSM-protected. - -When you specify this parameter, the *Destination* parameter is optional. - -```yaml -Type: String -Parameter Sets: Import -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyOps -Specifies an array of operations that can be performed by using the key that this cmdlet adds. -If you do not specify this parameter, all operations can be performed. - -The acceptable values for this parameter are a comma-separated list of key operations as defined by -the [JSON Web Key (JWK) specification](https://go.microsoft.com/fwlink/?LinkID=613300): - -- Encrypt -- Decrypt -- Wrap -- Unwrap -- Sign -- Verify - -```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 key to add to the key vault. This cmdlet constructs the fully qualified -domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key -vault, and your current environment. The name must be a string of 1 through 63 characters in length -that contains only 0-9, a-z, A-Z, and - (the dash symbol). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the time, as a **DateTime** object, before which the key cannot be used. This parameter -uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. If you do not specify this -parameter, the key can be used immediately. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which this cmdlet adds the key. This cmdlet constructs the -FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyBundle - -## NOTES - -## RELATED LINKS - -[Backup-AzureKeyVaultKey](./Backup-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Set-AzureKeyVaultKeyAttribute](./Set-AzureKeyVaultKeyAttribute.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultManagedStorageAccount.md b/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 31a4a9816c..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Add-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/add-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 ---- - -# Add-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> - [-AccountResourceId] <String> [-ActiveKeyName] <String> [-DisableAutoRegenerateKey] - [-RegenerationPeriod <TimeSpan>] [-Disable] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets up an existing Azure Storage Account with Key Vault for Storage Account keys to be managed by -Key Vault. The Storage Account must already exist. The Storage Keys are never exposed to caller. -Key Vault auto regenerates and switches the active key based on the regeneration period. - -## EXAMPLES - -### Example 1: Set an Azure Storage Account with Key Vault to manage its keys -``` -PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90) -PS C:\> Add-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -ResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/mystorageaccount' -ActiveKeyName 'key1' -RegenerationPeriod $regenerationPeriod -``` - -Sets a Storage Account with Key Vault for its keys to be managed by Key Vault. The active key set -is 'key1'. This key will be used to generate sas tokens. Key Vault will regenerate 'key2' key after -the regeneration period from the time of this command and set it as the active key. This auto -regeneration process will continue between 'key1' and 'key2' with a gap of 90 days. - -### Example 2: Set a Classic Azure Storage Account with Key Vault to manage its keys -``` -PS C:\> $regenerationPeriod = [System.Timespan]::FromDays(90) -PS C:\> Add-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -ResourceId '/subscriptions/<subscription id>/resourceGroups/myresourcegroup/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount' -ActiveKeyName 'Primary' -RegenerationPeriod $regenerationPeriod -``` - -Sets a Classic Storage Account with Key Vault for its keys to be managed by Key Vault. The active -key set is 'Primary'. This key will be used to generate sas tokens. Key Vault will regenerate -'Secondary' key after the regeneration period from the time of this command and set it as the -active key. This auto regeneration process will continue between 'Primary' and 'Secondary' with a -gap of 90 days. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountResourceId -Azure resource id of the storage account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountResourceId - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActiveKeyName -Name of the storage account key that must be used for generating sas tokens. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 -``` - -### -Disable -Disables the use of managed storage account's key for generation of sas tokens. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableAutoRegenerateKey -Auto regenerate key. If true, then the managed storage account's inactive key gets auto regenerated -and becomes the new active key after the regeneration period. If false, then the keys of managed -storage account are not auto regenerated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegenerationPeriod -Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after -which managed storage account's inactive keygets auto regenerated and becomes the new active key. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[AzureRM.KeyVault](/powershell/module/azurerm.keyvault) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/AzureRM.KeyVault.md b/azurermps-2.5.0/AzureRm.Keyvault/AzureRM.KeyVault.md deleted file mode 100644 index e02f6fb564..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/AzureRM.KeyVault.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -Module Name: AzureRM.KeyVault -Module Guid: D48CF693-4125-4D2D-8790-1514F44CE325 -Download Help Link: https://go.microsoft.com/fwlink/?linkid=390762 -Help Version: 4.0.0.0 -Locale: en-US ---- - -# AzureRM.KeyVault Module -## Description -This topic displays help topics for the Azure Key Vault Cmdlets. - -## AzureRM.KeyVault Cmdlets -### [Add-AzureKeyVaultCertificate](Add-AzureKeyVaultCertificate.md) -Adds a certificate to a key vault. - -### [Add-AzureKeyVaultCertificateContact](Add-AzureKeyVaultCertificateContact.md) -Adds a contact for certificate notifications. - -### [Add-AzureKeyVaultKey](Add-AzureKeyVaultKey.md) -Creates a key in a key vault or imports a key into a key vault. - -### [Add-AzureKeyVaultManagedStorageAccount](Add-AzureKeyVaultManagedStorageAccount.md) -Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. - -### [Backup-AzureKeyVaultKey](Backup-AzureKeyVaultKey.md) -Backs up a key in a key vault. - -### [Backup-AzureKeyVaultSecret](Backup-AzureKeyVaultSecret.md) -Backs up a secret in a key vault. - -### [Get-AzureKeyVaultCertificate](Get-AzureKeyVaultCertificate.md) -Gets a certificate from a key vault. - -### [Get-AzureKeyVaultCertificateContact](Get-AzureKeyVaultCertificateContact.md) -Gets contacts that are registered for certificate notifications for a key vault. - -### [Get-AzureKeyVaultCertificateIssuer](Get-AzureKeyVaultCertificateIssuer.md) -Gets a certificate issuer for a key vault. - -### [Get-AzureKeyVaultCertificateOperation](Get-AzureKeyVaultCertificateOperation.md) -Gets the status of a certificate operation. - -### [Get-AzureKeyVaultCertificatePolicy](Get-AzureKeyVaultCertificatePolicy.md) -Gets the policy for a certificate in a key vault. - -### [Get-AzureKeyVaultKey](Get-AzureKeyVaultKey.md) -Gets Key Vault keys. - -### [Get-AzureKeyVaultManagedStorageAccount](Get-AzureKeyVaultManagedStorageAccount.md) -Gets Key Vault managed Azure Storage Accounts. - -### [Get-AzureKeyVaultManagedStorageSasDefinition](Get-AzureKeyVaultManagedStorageSasDefinition.md) -Gets Key Vault managed Storage SAS Definitions. - -### [Get-AzureKeyVaultSecret](Get-AzureKeyVaultSecret.md) -Gets the secrets in a key vault. - -### [Get-AzureRmKeyVault](Get-AzureRmKeyVault.md) -Gets key vaults. - -### [Import-AzureKeyVaultCertificate](Import-AzureKeyVaultCertificate.md) -Imports a certificate to a key vault. - -### [New-AzureKeyVaultCertificateAdministratorDetails](New-AzureKeyVaultCertificateAdministratorDetails.md) -Creates an in-memory certificate administrator details object. - -### [New-AzureKeyVaultCertificateOrganizationDetails](New-AzureKeyVaultCertificateOrganizationDetails.md) -Creates an in-memory certificate organization details object. - -### [New-AzureKeyVaultCertificatePolicy](New-AzureKeyVaultCertificatePolicy.md) -Creates an in-memory certificate policy object. - -### [New-AzureRmKeyVault](New-AzureRmKeyVault.md) -Creates a key vault. - -### [Remove-AzureKeyVaultCertificate](Remove-AzureKeyVaultCertificate.md) -Removes a certificate from a key vault. - -### [Remove-AzureKeyVaultCertificateContact](Remove-AzureKeyVaultCertificateContact.md) -Deletes a contact that is registered for certificate notifications from a key vault. - -### [Remove-AzureKeyVaultCertificateIssuer](Remove-AzureKeyVaultCertificateIssuer.md) -Deletes a certificate issuer from a key vault. - -### [Remove-AzureKeyVaultCertificateOperation](Remove-AzureKeyVaultCertificateOperation.md) -Deletes a certificate operation from a key vault. - -### [Remove-AzureKeyVaultKey](Remove-AzureKeyVaultKey.md) -Deletes a key in a key vault. - -### [Remove-AzureKeyVaultManagedStorageAccount](Remove-AzureKeyVaultManagedStorageAccount.md) -Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. - -### [Remove-AzureKeyVaultManagedStorageSasDefinition](Remove-AzureKeyVaultManagedStorageSasDefinition.md) -Removes a Key Vault managed Azure Storage SAS definitions. - -### [Remove-AzureKeyVaultSecret](Remove-AzureKeyVaultSecret.md) -Deletes a secret in a key vault. - -### [Remove-AzureRmKeyVault](Remove-AzureRmKeyVault.md) -Deletes a key vault. - -### [Remove-AzureRmKeyVaultAccessPolicy](Remove-AzureRmKeyVaultAccessPolicy.md) -Removes all permissions for a user or application from a key vault. - -### [Restore-AzureKeyVaultKey](Restore-AzureKeyVaultKey.md) -Creates a key in a key vault from a backed-up key. - -### [Restore-AzureKeyVaultSecret](Restore-AzureKeyVaultSecret.md) -Creates a secret in a key vault from a backed-up secret. - -### [Set-AzureKeyVaultCertificateAttribute](Set-AzureKeyVaultCertificateAttribute.md) -Modifies editable attributes of a certificate. - -### [Set-AzureKeyVaultCertificateIssuer](Set-AzureKeyVaultCertificateIssuer.md) -Sets a certificate issuer in a key vault. - -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. - -### [Set-AzureKeyVaultKeyAttribute](Set-AzureKeyVaultKeyAttribute.md) -Updates the attributes of a key in a key vault. - -### [Set-AzureKeyVaultManagedStorageSasDefinition](Set-AzureKeyVaultManagedStorageSasDefinition.md) -Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. - -### [Set-AzureKeyVaultSecret](Set-AzureKeyVaultSecret.md) -Creates or updates a secret in a key vault. - -### [Set-AzureKeyVaultSecretAttribute](Set-AzureKeyVaultSecretAttribute.md) -Updates attributes of a secret in a key vault. - -### [Set-AzureRmKeyVaultAccessPolicy](Set-AzureRmKeyVaultAccessPolicy.md) -Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. - -### [Stop-AzureKeyVaultCertificateOperation](Stop-AzureKeyVaultCertificateOperation.md) -Cancels a certificate operation in key vault. - -### [Undo-AzureKeyVaultCertificateRemoval](Undo-AzureKeyVaultCertificateRemoval.md) -Recovers a deleted certificate in a key vault into an active state. - -### [Undo-AzureKeyVaultKeyRemoval](Undo-AzureKeyVaultKeyRemoval.md) -Recovers a deleted key in a key vault into an active state. - -### [Undo-AzureKeyVaultSecretRemoval](Undo-AzureKeyVaultSecretRemoval.md) -Recovers a deleted secret in a key vault into an active state. - -### [Undo-AzureRmKeyVaultRemoval](Undo-AzureRmKeyVaultRemoval.md) -Recovers a deleted key vault into an active state. - -### [Update-AzureKeyVaultManagedStorageAccount](Update-AzureKeyVaultManagedStorageAccount.md) -Update editable attributes of a Key Vault managed Azure Storage Account. - -### [Update-AzureKeyVaultManagedStorageAccountKey](Update-AzureKeyVaultManagedStorageAccountKey.md) -Regenerates the specified key of Key Vault managed Azure Storage Account. - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultKey.md deleted file mode 100644 index 4e88beee81..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultKey.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: A82392AA-B12B-443E-8704-7CF5A9F8ED58 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultkey -schema: 2.0.0 ---- - -# Backup-AzureKeyVaultKey - -## SYNOPSIS -Backs up a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByKeyName (Default) -``` -Backup-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByKey -``` -Backup-AzureKeyVaultKey [-Key] <KeyBundle> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultKey** cmdlet backs up a specified key in a key vault by downloading it and storing it in a file. -If there are multiple versions of the key, all versions are included in the backup. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up key to any key vault in the subscription that it was backed up from. - -Typical reasons to use this cmdlet are: - -- You want to escrow a copy of your key, so that you have an offline copy in case you accidentally delete your key in your key vault. - -- You created a key using Key Vault and now want to clone the key into a different Azure region, so that you can use it from all instances of your distributed application. -Use the **Backup-AzureKeyVaultKey** cmdlet to retrieve the key in encrypted format and then use the Restore-AzureKeyVaultKey cmdlet and specify a key vault in the second region. - -## EXAMPLES - -### Example 1: Back up a key with an automatically generated file name -``` -PS C:\>Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -``` - -This command retrieves the key named MyKey from the key vault named MyKeyVault and saves a backup of that key to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a key to a specified file name -``` -PS C:\>Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob' -``` - -This command retrieves the key named MyKey from the key vaultnamed MyKeyVault and saves a backup of that key to a file named Backup.blob. - -### Example 3: Back up a previously retrieved key to a specified file name, overwriting the destination file without prompting. -``` -PS C:\>$key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -PS C:\>Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force -``` - -This command creates a backup of the key named $key.Name in the vault named $key.VaultName to a file named Backup.blob, silently overwriting the file if it exists already. - -## 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 -Overwrite the given file if it exists - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies a previously retrieved key which is to be backed up. - -```yaml -Type: KeyBundle -Parameter Sets: ByKey -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key to back up. - -```yaml -Type: String -Parameter Sets: ByKeyName -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Specifies the output file in which the backup blob is stored. -If you do not specify this parameter, this cmdlet generates a file name for you. -If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault that contains the key to back up. - -```yaml -Type: String -Parameter Sets: ByKeyName -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### String -The cmdlet returns the path of the output file containing the backup of the key. - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Restore-AzureKeyVaultKey](./Restore-AzureKeyVaultKey.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultSecret.md b/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultSecret.md deleted file mode 100644 index 494ef2882d..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Backup-AzureKeyVaultSecret.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 80AAA327-77C6-4372-9461-FFED5A15E678 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/backup-azurekeyvaultsecret -schema: 2.0.0 ---- - -# Backup-AzureKeyVaultSecret - -## SYNOPSIS -Backs up a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySecretName (Default) -``` -Backup-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySecret -``` -Backup-AzureKeyVaultSecret [-Secret] <Secret> [[-OutputFile] <String>] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Backup-AzureKeyVaultSecret** cmdlet backs up a specified secret in a key vault by downloading it and storing it in a file. -If there are multiple versions of the secret, all versions are included in the backup. -Because the downloaded content is encrypted, it cannot be used outside of Azure Key Vault. -You can restore a backed-up secret to any key vault in the subscription that it was backed up from. - -Typical reasons to use this cmdlet are: - -- You want to escrow a copy of your secret, so that you have an offline copy in case you accidentally delete your secret in your key vault. -- You added a secret to a key vault and now want to clone the secret into a different Azure region, so that you can use it from all instances of your distributed application. Use the Backup-AzureKeyVaultSecret cmdlet to retrieve the secret in encrypted format and then use the Restore-AzureKeyVaultSecret cmdlet and specify a key vault in the second region. (Note that the regions must belong to the same geography.) - -## EXAMPLES - -### Example 1: Back up a secret with an automatically generated file name -``` -PS C:\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -``` - -This command retrieves the secret named MySecret from the key vault named MyKeyVault and saves a backup of that secret to a file that is automatically named for you, and displays the file name. - -### Example 2: Back up a secret to a specified file name, overwriting the existing file without prompting -``` -PS C:\>Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force -``` - -This command retrieves the secret named MySecret from the key vaultnamed MyKeyVault and saves a backup of that secret to a file named Backup.blob. - -### Example 3: Back up a secret previously retrieved to a specified file name -``` -PS C:\>$secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -PS C:\>Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob' -``` - -This command uses the $secret object's vault name and name to retrieves the secret and saves its backup to a file named Backup.blob. - -## 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 -Prompts you for confirmation before overwriting the output file, if that exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secret to back up. - -```yaml -Type: String -Parameter Sets: BySecretName -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Specifies the output file in which the backup blob is stored. -If you do not specify this parameter, this cmdlet generates a file name for you. -If you specify the name of an existing output file, the operation will not complete and returns an error message that the backup file already exists. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Secret -Specifies the object whose name and vault should be used for the backup operation. - -```yaml -Type: Secret -Parameter Sets: BySecret -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault that contains the secret to back up. - -```yaml -Type: String -Parameter Sets: BySecretName -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### String -The cmdlet returns the path of the output file containing the backup of the key. - -## NOTES - -## RELATED LINKS - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - -[Restore-AzureKeyVaultSecret](./Restore-AzureKeyVaultSecret.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificate.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificate.md deleted file mode 100644 index 7a695b704b..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 363FA51E-D075-4800-A4BE-BFF63FD25C90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificate -schema: 2.0.0 ---- - -# Get-AzureKeyVaultCertificate - -## SYNOPSIS -Gets a certificate from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByCertificateName -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByCertificateVersions -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDeletedCertificates -``` -Get-AzureKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificate** cmdlet gets the specified certificate or the versions of a certificate from a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate -``` -PS C:\>Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Name : testCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - 05979C5A2F0741D5A3B6F97673E8A118 - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - 3E9B6848AD1834284157D68B060F748037F663C8 - -Thumbprint : 3E9B6848AD1834284157D68B060F748037F663C8 -Tags : -Enabled : True -Created : 2/8/2016 11:21:45 PM -Updated : 2/8/2016 11:21:45 PM -``` - -This command gets the certificate named TestCert01 from the key vault named ContosoKV01. - -### Example 2: Get all the certificates that have been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -InRemovedState -``` - -This command gets all the certificates that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 3: Gets the certificate MyCert that has been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState -``` - -This command gets the certificate named 'MyCert' that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted certificate. - -## 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 -``` - -### -IncludeVersions -Indicates that this operation gets all versions of the certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: ByCertificateVersions -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to include previously deleted certificates in the output - -```yaml -Type: SwitchParameter -Parameter Sets: ByDeletedCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate to get. - -```yaml -Type: String -Parameter Sets: ByCertificateName, ByCertificateVersions -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ByDeletedCertificates -Aliases: CertificateName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of a certificate. - -```yaml -Type: String -Parameter Sets: ByCertificateName -Aliases: CertificateVersion - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.CertificateIdentityItem] - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificate](./Add-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateContact.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateContact.md deleted file mode 100644 index 30dbc0e070..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 200C68A3-A79C-4517-8E5D-8128F6C73A5C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificatecontact -schema: 2.0.0 ---- - -# Get-AzureKeyVaultCertificateContact - -## SYNOPSIS -Gets contacts that are registered for certificate notifications for a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureKeyVaultCertificateContact [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateContact** cmdlet gets contacts that are registered for certificate notifications for a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get all certificate contacts -``` -PS C:\>$Contacts = Get-AzureKeyVaultCertificateContact -VaultName "Contoso" -``` - -This command gets all of the contacts for the certificate objects in the Contoso key vault, and then stores them in the $Contacts variable. - -## 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 -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### List<Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateContact> - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificateContact](./Add-AzureKeyVaultCertificateContact.md) - -[Remove-AzureKeyVaultCertificateContact](./Remove-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateIssuer.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index e3aa6e5219..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 5F856280-C561-47B5-AA96-27E34C86D604 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificateissuer -schema: 2.0.0 ---- - -# Get-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Gets a certificate issuer for a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByName -``` -Get-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateIssuer** cmdlet gets a specified certificate issuer or all certificate issuers for a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate issuer -``` -PS C:\>Get-AzureKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" -Name : TestIssuer01 -IssuerProvider : Test -AccountId : 555 -ApiKey : -OrganizationDetails : Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOrganizationDetails -``` - -This command gets the certificate issuer named TestIssuer01. - -## 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 -Specifies the name of the certificate issuer to get. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: IssuerName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### List<Microsoft.Azure.Commands.KeyVault.Models.CertificateIssuerIdentityItem>, Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateIssuer - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificateIssuer](./Remove-AzureKeyVaultCertificateIssuer.md) - -[Set-AzureKeyVaultCertificateIssuer](./Set-AzureKeyVaultCertificateIssuer.md) - - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateOperation.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index 627d94fd4a..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0743C43D-2A1F-4950-B0F3-1FED4014EEC5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificateoperation -schema: 2.0.0 ---- - -# Get-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Gets the status of a certificate operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificateOperation** cmdlet gets the status of a certificate operation. - -## EXAMPLES - -### Example 1: Get the status of a certificate operation -``` -PS C:\>Get-AzureKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Status : inProgress -CancellationRequested : False -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l - 5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9 - i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6 - YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf - eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg== -ErrorCode : -ErrorMessage : -``` - -This command gets the status of the certificate operation for TestCert01 on the ContosoKV01 key vault. - -## 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 -Specifies the name of a certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificateOperation](./Remove-AzureKeyVaultCertificateOperation.md) - -[Stop-AzureKeyVaultCertificateOperation](./Stop-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificatePolicy.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index 63bb2862ef..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0729687C-3104-4136-A80D-16BAEBD6B76C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultcertificatepolicy -schema: 2.0.0 ---- - -# Get-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Gets the policy for a certificate in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultCertificatePolicy** cmdlet gets the policy for a certificate in a key vault in Azure Key Vault. - -## EXAMPLES - -### Example 1: Get a certificate policy -``` -PS C:\>Get-AzureKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" -SecretContentType : application/x-pkcs12 -Kty : RSA -KeySize : 2048 -Exportable : True -ReuseKeyOnRenewal : True -SubjectName : CN=contoso.com -DnsNames : -Ekus : {1.3.6.1.5.5.7.3.1, 1.3.6.1.5.5.7.3.2} -ValidityInMonths : 6 -IssuerName : Self -RenewAtNumberOfDaysBeforeExpiry : -RenewAtPercentageLifetime : 80 -EmailOnly : False -Enabled : True -Created : 2/8/2016 11:10:29 PM -Updated : 2/8/2016 11:10:29 PM -``` - -This command gets the certificate policy for TestCert01 certificate in the ContosoKV01 key vault. - -## 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 -Specifies the name of a certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificatePolicy](./New-AzureKeyVaultCertificatePolicy.md) - -[Set-AzureKeyVaultCertificatePolicy](./Set-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultKey.md deleted file mode 100644 index 036281eb88..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultKey.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2BE34AE1-06FA-4F66-8FDB-CED22C2E0978 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultkey -schema: 2.0.0 ---- - -# Get-AzureKeyVaultKey - -## SYNOPSIS -Gets Key Vault keys. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultKey [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByKeyName -``` -Get-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByKeyVersions -``` -Get-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDeletedKey -``` -Get-AzureKeyVaultKey [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultKey** cmdlet gets Azure Key Vault keys. -This cmdlet gets a specific **Microsoft.Azure.Commands.KeyVault.Models.KeyBundle** or a list of all **KeyBundle** objects in a key vault or by version. - -## EXAMPLES - -### Example 1: Get all the keys in a key vault -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' -``` - -This command gets all the keys in the key vault named Contoso. - -### Example 2: Get the current version of a key -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' -KeyName 'ITPfx' -``` - -This command gets the current version of the key named ITPfx in the key vault named Contoso. - -### Example 3: Get all versions of a key -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' -KeyName 'ITPfx' -IncludeVersions -``` - -This command gets all versions the key named ITPfx in the key vaultnamed Contoso. - -### Example 4: Get a specific version of a key -``` -PS C:\>$Key = Get-AzureKeyVaultKey -VaultName 'Contoso' -KeyName 'ITPfx' -Version '5A12A276385949DB8B5F82AFEE85CAED' -``` - -This command gets a specific version of the key named ITPfx in the key vault named Contoso. -After running this command, you can inspect various properties of the key by navigating the $Key object. - -### Example 5: Get all the keys that have been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' -InRemovedState -``` - -This command gets all the keys that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 6: Gets the key ITPfx that has been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' -KeyName 'ITPfx' -InRemovedState -``` - -This command gets the key ITPfx that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted key. - -## 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 -``` - -### -IncludeVersions -Indicates that this cmdlet gets all versions of a key. -The current version of a key is the first one on the list. -If you specify this parameter you must also specify the *Name* and *VaultName* parameters. - -If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the key with the specified *Name*. - -```yaml -Type: SwitchParameter -Parameter Sets: ByKeyVersions -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted keys in the output - -```yaml -Type: SwitchParameter -Parameter Sets: ByDeletedKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key bundle to get. - -```yaml -Type: String -Parameter Sets: ByKeyName, ByKeyVersions -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ByDeletedKey -Aliases: KeyName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which this cmdlet gets keys. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the key version. -This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key name, and the key version. - -```yaml -Type: String -Parameter Sets: ByKeyName -Aliases: KeyVersion - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String - -## OUTPUTS - -### List<Microsoft.Azure.Commands.KeyVault.Models.KeyIdentityItem>, Microsoft.Azure.Commands.KeyVault.Models.KeyBundle, List<Microsoft.Azure.Commands.KeyVault.Models.DeletedKeyIdentityItem>, Microsoft.Azure.Commands.KeyVault.Models.DeletedKeyBundle - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Undo-AzureKeyVaultKeyRemoval](./Undo-AzureKeyVaultKeyRemoval.md) - -[Set-AzureKeyVaultKeyAttribute](./Set-AzureKeyVaultKeyAttribute.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageAccount.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 77603e5334..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 ---- - -# Get-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Gets Key Vault managed Azure Storage Accounts. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByAccountName -``` -Get-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Key Vault managed Azure Storage Account if the name of the account is specified and the account keys are managed by the specified vault. If the account name is not specified, then all the accounts whose keys are managed by specified vault are listed. - -## EXAMPLES - -### Example 1: List all Key Vault managed Storage Accounts -``` -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -``` - -Lists all the accounts whose keys are managed by vault 'myvault' - -### Example 2: Get a Key Vault managed Storage Account -``` -PS C:\> Get-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -Name 'mystorageaccount' -``` - -Gets the details of Key Vault managed Storage Account of 'mystorageaccount' if its keys are managed by vault 'myvault' - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: ByAccountName -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -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 -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount, Microsoft.Azure.Commands.KeyVault, Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index 47a629a47a..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 ---- - -# Get-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Gets Key Vault managed Storage SAS Definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAccountName (Default) -``` -Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDefinitionName -``` -Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Gets a Key Vault managed Storage SAS Definition if the name of the definition is specified. If the definition name is not specified, then all the SAS definitions associated with the specified Key Vault managed Storage Account in the vault are listed. - -## EXAMPLES - -### Example 1: List all Key Vault managed Storage SAS Definitions -``` -PS C:\> Get-AzureKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -``` - -Lists all the SAS definitions associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault' - -### Example 2: Get a Key Vault managed Storage Account -``` -PS C:\> Get-AzureKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasDef' -``` - -Gets the details of SAS Definition 'mysasDef' associated with Key Vault managed Storage Account 'mystorageaccount' managed by vault 'myvault'. - -## PARAMETERS - -### -AccountName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -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 -Storage sas definition name. -Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: String -Parameter Sets: ByDefinitionName -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageSasDefinitionListItem, Microsoft.Azure.Commands.KeyVault, Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]] -Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultSecret.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultSecret.md deleted file mode 100644 index 2b71965447..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureKeyVaultSecret.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 8C9B33EE-10DE-4803-B76D-FE9FC2AC3372 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurekeyvaultsecret -schema: 2.0.0 ---- - -# Get-AzureKeyVaultSecret - -## SYNOPSIS -Gets the secrets in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByVaultName (Default) -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BySecretName -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BySecretVersions -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-IncludeVersions] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDeletedSecrets -``` -Get-AzureKeyVaultSecret [-VaultName] <String> [[-Name] <String>] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureKeyVaultSecret** cmdlet gets secrets in a key vault. -This cmdlet gets a specific secret or all the secrets in a key vault. - -## EXAMPLES - -### Example 1: Get all current versions of all secrets in a key vault -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -``` - -This command gets the current versions of all secrets in the key vault named Contoso. - -### Example 2: Get all versions of a specific secret -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -IncludeVersions -``` - -This command gets all versions of the secret named ITSecret in the key vault named Contoso. - -### Example 3: Get the current version of a specific secret -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -``` - -This command gets the current version of the secret named ITSecret in the key vault named Contoso. - -### Example 4: Get a specific version of a specific secret -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -Version '6A12A286385949DB8B5F82AFEF85CAE9' -``` - -This command gets a specific version of the secret named ITSecret in the key vault named Contoso. - -### Example 5: Get the plain text value of the current version of a specific secret -``` -PS C:\>$secret = Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -PS C:\> Write-Host "Secret Value is: " $secret.SecretValueText -``` - -These commands get the current version of a secret named ITSecret, and then displays the plain text value of that secret. - -### Example 6: Get all the secrets that have been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -InRemovedState -``` - -This command gets all the secrets that have been previously deleted, but not purged, in the key vault named Contoso. - -### Example 7: Gets the secret ITSecret that has been deleted but not purged for this key vault. -``` -PS C:\>Get-AzureKeyVaultSecret -VaultName 'Contoso' -KeyName 'ITSecret' -InRemovedState -``` - -This command gets the secret ITSecret that has been previously deleted, but not purged, in the key vault named Contoso. -This command will return metadata such as the deletion date, and the scheduled purging date of this deleted secret. - -## 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 -``` - -### -IncludeVersions -Indicates that this cmdlet gets all versions of a secret. -The current version of a secret is the first one on the list. -If you specify this parameter you must also specify the *Name* and *VaultName* parameters. - -If you do not specify the *IncludeVersions* parameter, this cmdlet gets the current version of the secret with the specified *Name*. - -```yaml -Type: SwitchParameter -Parameter Sets: BySecretVersions -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Specifies whether to show the previously deleted secrets in the output - -```yaml -Type: SwitchParameter -Parameter Sets: ByDeletedSecrets -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secret to get. - -```yaml -Type: String -Parameter Sets: BySecretName, BySecretVersions -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ByDeletedSecrets -Aliases: SecretName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which the secret belongs. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the secret version. -This cmdlet constructs the FQDN of a secret based on the key vault name, your currently selected environment, the secret name, and the secret version. - -```yaml -Type: String -Parameter Sets: BySecretName -Aliases: SecretVersion - -Required: False -Position: 2 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String - -## OUTPUTS - -### List<Microsoft.Azure.Commands.KeyVault.Models.SecretIdentityItem>, Microsoft.Azure.Commands.KeyVault.Models.Secret, List<Microsoft.Azure.Commands.KeyVault.Models.DeletedSecretIdentityItem>, Microsoft.Azure.Commands.KeyVault.Models.DeletedSecret - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - -[Undo-AzureKeyVaultSecretRemoval](./Undo-AzureKeyVaultSecretRemoval.md) - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureRmKeyVault.md b/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureRmKeyVault.md deleted file mode 100644 index 1fd6692048..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Get-AzureRmKeyVault.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: A7C287C4-E9FD-407A-91BD-EFA17C33FC8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/get-azurermkeyvault -schema: 2.0.0 ---- - -# Get-AzureRmKeyVault - -## SYNOPSIS -Gets key vaults. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetVaultByName -``` -Get-AzureRmKeyVault [-VaultName] <String> [[-ResourceGroupName] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByDeletedVault -``` -Get-AzureRmKeyVault [-VaultName] <String> [-Location] <String> [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListVaultsByResourceGroup -``` -Get-AzureRmKeyVault [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ListAllDeletedVaultsInSubscription -``` -Get-AzureRmKeyVault [-InRemovedState] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ListAllVaultsInSubscription -``` -Get-AzureRmKeyVault [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmKeyVault** cmdlet gets information about the key vaults in a subscription. You can -view all key vaults instances in a subscription, or filter your results by a resource group or a -particular key vault. - -Note that although specifying the resource group is optional for this cmdlet when you get a single -key vault, you should do so for better performance. - -## EXAMPLES - -### Example 1: Get all key vaults in your current subscription -``` -PS C:\>Get-AzureRMKeyVault -``` - -This command gets all the key vaults in your current subscription. - -### Example 2: Get a specific key vault -``` -PS C:\>$MyVault = Get-AzureRMKeyVault -VaultName 'Contoso03Vault' -``` - -This command gets the key vault named Contoso03Vault in your current subscription, and then stores -it in the $MyVault variable. You can inspect the properties of $MyVault to get details about the -key vault. - -### Example 3: Get key vaults in a resource group -``` -PS C:\>Get-AzureRmKeyVault -ResourceGroupName 'ContosoPayRollResourceGroup' -``` - -This command gets all the key vaults in the resource group named ContosoPayRollResourceGroup. - -### Example 4: Get all deleted key vaults in your current subscription -``` -PS C:\>Get-AzureRmKeyVault -InRemovedState -``` - -This command gets all the deleted key vaults in your current subscription. - -### Example 5: Get a deleted key vault -``` -PS C:\>Get-AzureRMKeyVault -VaultName 'Contoso03Vault' -Location 'eastus2' -InRemovedState -``` - -This command gets the deleted key vault information named Contoso03Vault in your current -subscription and in eastus2 region. - -## 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 -``` - -### -InRemovedState -Specifies whether to show the previously deleted vaults in the output. - -```yaml -Type: SwitchParameter -Parameter Sets: ByDeletedVault, ListAllDeletedVaultsInSubscription -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the deleted vault. - -```yaml -Type: String -Parameter Sets: ByDeletedVault -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault or key vaults being queried. - -```yaml -Type: String -Parameter Sets: GetVaultByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ListVaultsByResourceGroup -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: ListAllVaultsInSubscription -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: String -Parameter Sets: GetVaultByName, ByDeletedVault -Aliases: Name - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSVault - -### System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSVaultIdentityItem] - -### Microsoft.Azure.Commands.KeyVault.Models.PSDeletedVault - -### System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSDeletedVault] - -## NOTES - -## RELATED LINKS - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Import-AzureKeyVaultCertificate.md b/azurermps-2.5.0/AzureRm.Keyvault/Import-AzureKeyVaultCertificate.md deleted file mode 100644 index 9925e07bf9..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Import-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: D4188DC6-A8AB-4B45-9781-94B74C338C63 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/import-azurekeyvaultcertificate -schema: 2.0.0 ---- - -# Import-AzureKeyVaultCertificate - -## SYNOPSIS -Imports a certificate to a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ImportCertificateFromFile (Default) -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> -FilePath <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ImportWithPrivateKeyFromFile -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> -FilePath <String> - [-Password <SecureString>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ImportWithPrivateKeyFromString -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> -CertificateString <String> - [-Password <SecureString>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ImportWithPrivateKeyFromCollection -``` -Import-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> - -CertificateCollection <X509Certificate2Collection> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Import-AzureKeyVaultCertificate** cmdlet imports a certificate into a key vault. - -You can create the certificate to import by using one of the following methods: - -- Use the New-AzureKeyVaultCertificateSigningRequest cmdlet to create a certificate signing request and submit it to a certificate authority. -- Use an existing certificate package file, such as a .pfx or .p12 file, which contains both the certificate and private key. - -## EXAMPLES - -### Example 1: Import a key vault certificate -``` -PS C:\>$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force -PS C:\> Import-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password -Name : importCert01 -Certificate : [Subject] - CN=contoso.com - - [Issuer] - CN=contoso.com - - [Serial Number] - 05979C5A2F0741D5A3B6F97673E8A118 - - [Not Before] - 2/8/2016 3:11:45 PM - - [Not After] - 8/8/2016 4:21:45 PM - - [Thumbprint] - 3E9B6848AD1834284157D68B060F748037F663C8 - -Thumbprint : 3E9B6848AD1834284157D68B060F748037F663C8 -Tags : -Enabled : True -Created : 2/8/2016 11:50:43 PM -Updated : 2/8/2016 11:50:43 PM -``` - -The first command uses the ConvertTo-SecureString cmdlet to create a secure password, and then -stores it in the $Password variable. - -The second command imports the certificate named ImportCert01 into the CosotosoKV01 key vault. - -## PARAMETERS - -### -CertificateCollection -Specifies the certificate collection to add to a key vault. - -```yaml -Type: X509Certificate2Collection -Parameter Sets: ImportWithPrivateKeyFromCollection -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateString -Specifies a certificate string. - -```yaml -Type: String -Parameter Sets: ImportWithPrivateKeyFromString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: 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 that this cmdlet imports. - -```yaml -Type: String -Parameter Sets: ImportCertificateFromFile, ImportWithPrivateKeyFromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the certificate name. This cmdlet constructs the fully qualified domain name (FQDN) of a -certificate from key vault name, currently selected environment, and certificate name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies the password for a certificate file. - -```yaml -Type: SecureString -Parameter Sets: ImportWithPrivateKeyFromFile, ImportWithPrivateKeyFromString -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the key vault name into which this cmdlet imports certificates. -This cmdlet constructs the fully qualified domain name (FQDN) of a key vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.CertificateBundle - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateAdministratorDetails.md b/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateAdministratorDetails.md deleted file mode 100644 index 6516fe6bd0..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateAdministratorDetails.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 775AB0E8-EC3C-4F96-8AF8-51C1DFEEF082 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificateadministratordetails -schema: 2.0.0 ---- - -# New-AzureKeyVaultCertificateAdministratorDetails - -## SYNOPSIS -Creates an in-memory certificate administrator details object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureKeyVaultCertificateAdministratorDetails [-FirstName <String>] [-LastName <String>] - [-EmailAddress <String>] [-PhoneNumber <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificateAdministratorDetails** cmdlet creates an in-memory certificate administrator details object. - -## EXAMPLES - -### Example 1: Create a certificate administrator details object -``` -PS C:\>$AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName "Patti" -LastName "Fuller" -EmailAddress "patti.fuller@contoso.com" -PhoneNumber "5553334444" -``` - -This command creates an in-memory certificate administrator details object, and then stores it in the $AdminDetails variable. - -## 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 -``` - -### -EmailAddress -Specifies the email address for the certificate administrator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstName -Specifies the first name of the certificate administrator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LastName -Specifies the last name of the certificate administrator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PhoneNumber -Specifies the phone number of the certificate administrator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateAdministratorDetails - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificateOrganizationDetails](./New-AzureKeyVaultCertificateOrganizationDetails.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateOrganizationDetails.md b/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateOrganizationDetails.md deleted file mode 100644 index 398959d4de..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificateOrganizationDetails.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 0E1C05B0-8CF6-4C03-AA05-B13A4059A280 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificateorganizationdetails -schema: 2.0.0 ---- - -# New-AzureKeyVaultCertificateOrganizationDetails - -## SYNOPSIS -Creates an in-memory certificate organization details object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureKeyVaultCertificateOrganizationDetails [-Id <String>] - [-AdministratorDetails <System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateAdministratorDetails]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificateOrganizationDetails** cmdlet creates an in-memory certificate organization details object. - -## EXAMPLES - -### Example 1: Create an organization details object -``` -PS C:\>$AdminDetails = New-AzureKeyVaultCertificateAdministratorDetails -FirstName "Patti" -LastName "Fuller" -EmailAddress "Patti.Fuller@contoso.com" -PhoneNumber "1234567890" -$OrgDetails = New-AzureKeyVaultCertificateOrganizationDetails -Name "Contoso" -Address1 "1 Redmond Way" -Address2 "Suite 906" -City "Redmond" -State "WA" -Zip 98052 -Country "US" -AdministratorDetails $AdminDetails -``` - -The first command creates a certificate administrator details object, and then stores it in the $AdminDetails variable. - -The second command creates a certificate organization details object, and then stores it in the $OrgDetails variable. - -## PARAMETERS - -### -AdministratorDetails -Specifies the certificate organization administrators. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateAdministratorDetails] -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 - -```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 identifier for the organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOrganizationDetails - -## NOTES - -## RELATED LINKS - -[New-AzureKeyVaultCertificateAdministratorDetails](./New-AzureKeyVaultCertificateAdministratorDetails.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificatePolicy.md b/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index cee885fdf3..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 25E0F0E9-BF8C-49DF-87BA-31E2103A29A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurekeyvaultcertificatepolicy -schema: 2.0.0 ---- - -# New-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Creates an in-memory certificate policy object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureKeyVaultCertificatePolicy [-SecretContentType <String>] [-ReuseKeyOnRenewal] [-Disabled] - [-SubjectName <String>] [-DnsNames <System.Collections.Generic.List`1[System.String]>] - [-KeyUsage <System.Collections.Generic.List`1[System.String]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] -IssuerName <String> - [-CertificateType <String>] [-RenewAtNumberOfDaysBeforeExpiry <Int32>] [-RenewAtPercentageLifetime <Int32>] - [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] [-KeyType <String>] - [-KeyNotExportable] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureKeyVaultCertificatePolicy** cmdlet creates an in-memory certificate policy object for Azure Key Vault. - -## EXAMPLES - -### Example 1: Create a certificate policy -``` -PS C:\>New-AzureKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal -``` - -This command creates a certificate policy that is valid for six months and reuses the key to renew the certificate. - -## PARAMETERS - -### -CertificateType -Specifies the type of certificate to the issuer. - -```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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the certificate policy is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsNames -Specifies the DNS names in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ekus -Specifies the enhanced key usages (EKUs) in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtNumberOfDaysBeforeExpiry -Specifies how many days before expiry the automatic notification process begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for the notification begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuerName -Specifies the name of the issuer for the certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyNotExportable -Indicates that the key is not exportable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyType -Specifies the key type of the key that backs the certificate. -The acceptable values for this parameter are: - -- RSA -- RSA-HSM - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: RSA, RSA-HSM - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyUsage -Specifies the key usages in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RenewAtNumberOfDaysBeforeExpiry -Specifies the number of days before expiry after which the automatic process for certificate renewal begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RenewAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReuseKeyOnRenewal -Indicates that the certificate reuse the key during renewal. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretContentType -Specifies the content type of the new key vault secret. -The acceptable values for this parameter are: - -- application/x-pkcs12 -- application/x-pem-file - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: application/x-pkcs12, application/x-pem-file - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectName -Specifies the subject name of the certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidityInMonths -Specifies the number of months the certificate is valid. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificatePolicy](./Get-AzureKeyVaultCertificatePolicy.md) - -[Set-AzureKeyVaultCertificatePolicy](./Set-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureRmKeyVault.md b/azurermps-2.5.0/AzureRm.Keyvault/New-AzureRmKeyVault.md deleted file mode 100644 index 8798553476..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/New-AzureRmKeyVault.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 4C40DAC9-5C0B-4AFD-9BDB-D407E0B9F701 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/new-azurermkeyvault -schema: 2.0.0 ---- - -# New-AzureRmKeyVault - -## SYNOPSIS -Creates a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmKeyVault [-VaultName] <String> [-ResourceGroupName] <String> [-Location] <String> - [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-EnableSoftDelete] - [-Sku <SkuName>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmKeyVault** cmdlet creates a key vault in the specified resource group. This cmdlet -also grants permissions to the currently logged on user to add, remove, or list keys and secrets in -the key vault. - -Note: If you see the error **The subscription is not registered to use namespace -'Microsoft.KeyVault'** when you try to create your new key vault, run -**Register-AzureRmResourceProvider -ProviderNamespace "Microsoft.KeyVault"** and then rerun your -**New-AzureRmKeyVault** command. For more information, see Register-AzureRmResourceProvider. - -## EXAMPLES - -### Example 1: Create a Standard key vault -``` -PS C:\>New-AzureRmKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -``` - -This command creates a key vault named Contoso03Vault, in the Azure region East US. The command -adds the key vault to the resource group named Group14. Because the command does not specify a -value for the *SKU* parameter, it creates a Standard key vault. - -### Example 2: Create a Premium key vault -``` -PS C:\>New-AzureRmKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -Sku 'Premium' -``` - -This command creates a key vault, just like the previous example. However, it specifies a value of -Premium for the *SKU* parameter to create a Premium key vault. - -## 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 -``` - -### -EnabledForDeployment -Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this -key vault is referenced in resource creation, for example when creating a virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableSoftDelete -Specifies that the soft-delete functionality is enabled for this key vault. When soft-delete is enabled, for a grace period, you can recover this key vault and its contents after it is deleted. - -For more information about this functionality, see [Azure Key Vault soft-delete overview](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete). For how-to instructions, see [How to use Key Vault soft-delete with PowerShell](https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-powershell). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which to create the key vault. Use the command [Get-AzureRmLocation](/powershell/module/azurerm.resources/get-azurermlocation) to see your choices. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an existing resource group in which to create the key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU of the key vault instance. For information about which features are available for each SKU, see the Azure Key Vault Pricing website (https://go.microsoft.com/fwlink/?linkid=512521). - -```yaml -Type: SkuName -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to create. The name can be any combination of letters, digits, -or hyphens. The name must start and end with a letter or digit. The name must be universally -unique. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificate.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificate.md deleted file mode 100644 index 9410eb7798..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificate.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 34985F06-4D8D-463B-B113-972666D18485 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificate -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultCertificate - -## SYNOPSIS -Removes a certificate from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-Force] [-InRemovedState] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificate** cmdlet removes a certificate from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate -``` -PS C:\>Remove-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "SelfSigned01" -PassThru -Force -Name : selfSigned01 -Certificate : -Thumbprint : -Tags : -Enabled : True -Created : 2/8/2016 11:29:33 PM -Updated : 2/8/2016 11:29:33 PM -``` - -This command removes the certificate named SelfSigned01 from the key vault named ContosoKV01. -This command specifies the *Force* parameter. -Therefore, the cmdlet does not prompt you for confirmation. - -### Example 3: Purge the deleted certificate from the key vault permanently -``` -PS C:\>Remove-AzureKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState -``` - -This command permanently removes the certificate named 'MyCert' from the key vault named 'Contoso'. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user on this key vault. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -If present, removes the previously deleted certificate permanently - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate that this cmdlet removes from a key vault. -This cmdlet constructs the fully qualified domain name (FQDN) of a certificate based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which this cmdlet removes a certificate. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.CertificateBundle - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificate](./Add-AzureKeyVaultCertificate.md) - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) - -[Import-AzureKeyVaultCertificate](./Import-AzureKeyVaultCertificate.md) - -[Undo-AzureKeyVaultCertificateRemoval](./Undo-AzureKeyVaultCertificateRemoval.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateContact.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateContact.md deleted file mode 100644 index b3c448a2af..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateContact.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 35FAA57F-B2BD-4E43-8238-12F7A8269E4D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificatecontact -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultCertificateContact - -## SYNOPSIS -Deletes a contact that is registered for certificate notifications from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultCertificateContact [-VaultName] <String> [-EmailAddress] <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateContact** cmdlet deletes a contact that is registered for certificate notifications from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate contact -``` -PS C:\>Remove-AzureKeyVaultCertificateContact -VaultName "Contoso01" -EmailAddress "patti.fuller@contoso.com" -``` - -This command removes Patti Fuller as a certificate contact for the Contoso01 key vault. - -## 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 -``` - -### -EmailAddress -Specifies the email address of the contact to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateContact] - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificateContact](./Add-AzureKeyVaultCertificateContact.md) - -[Get-AzureKeyVaultCertificateContact](./Get-AzureKeyVaultCertificateContact.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateIssuer.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index e2d179faa6..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: FC14F6BF-BD8F-45E0-9CAA-A937E5E56288 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificateissuer -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Deletes a certificate issuer from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateIssuer** cmdlet deletes a certificate issuer from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate issuer -``` -PS C:\>Remove-AzureKeyVaultCertificateIssuer -VaultName "ContosoKV01" -Name "TestIssuer01" -Force -``` - -This command removes the certificate issuer named TestIssuer01 from the ContosoKV01 key vault. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the issuer to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IssuerName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateIssuer - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateIssuer](./Get-AzureKeyVaultCertificateIssuer.md) - -[Set-AzureKeyVaultCertificateIssuer](./Set-AzureKeyVaultCertificateIssuer.md) - - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateOperation.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index 7518760e88..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 2659C06A-AE5B-4F7B-B9EF-069A74E12560 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultcertificateoperation -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Deletes a certificate operation from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureKeyVaultCertificateOperation** cmdlet deletes a certificate operation from a key vault. - -## EXAMPLES - -### Example 1: Remove a certificate operation -``` -PS C:\>Remove-AzureKeyVaultCertificateOperation -VaultName "ContosoKV01" -Name "TestCert01" -Force -``` - -This command removes the certificate operation named TestCert01 from the ContosoKV01 key vault without prompting for confirmation. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateOperation](./Get-AzureKeyVaultCertificateOperation.md) - -[Stop-AzureKeyVaultCertificateOperation](./Stop-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultKey.md deleted file mode 100644 index 6f6ac0d490..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultKey.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 817BF177-519F-47BA-86CF-4591FB402E2Dl -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultkey -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultKey - -## SYNOPSIS -Deletes a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultKey [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureKeyVaultKey cmdlet deletes a key in a key vault. -If the key was accidentally deleted the key can be recovered using Undo-AzureKeyVaultKeyRemoval by a user with special 'recover' permissions. -This cmdlet has a value of high for the **ConfirmImpact** property. - -## EXAMPLES - -### Example 1: Remove a key from a key vault -``` -PS C:\>Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -``` - -This command removes the key named ITSoftware from the key vault named Contoso. - -### Example 2: Remove a key without user confirmation -``` -PS C:\>Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force -Confirm:$False -``` - -This command removes the key named ITSoftware from the key vault named Contoso. -The command specifies the *Force* and *Confirm* parameters, and, therefore, the cmdlet does not prompt you for confirmation. - -### Example 3: Purge a deleted key from the key vault permanently -``` -PS C:\>Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState -``` - -This command removes the key named ITSoftware from the key vault named Contoso permanently. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. - -### Example 4: Remove keys by using the pipeline operator -``` -PS C:\>Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey -``` - -This command gets all the keys in the key vault named Contoso, and passes them to the **Where-Object** cmdlet by using the pipeline operator. -That cmdlet passes the keys that have a value of $False for the **Enabled** attribute to the current cmdlet. -That cmdlet removes those keys. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Remove the previously deleted key permanently. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the key to remove. -This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.KeyBundle** object. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault from which to remove the key. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.DeletedKeyBundle -This cmdlet returns a value only if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Set-AzureKeyVaultKeyAttribute](./Set-AzureKeyVaultKeyAttribute.md) - -[Undo-AzureKeyVaultKeyRemoval](./Undo-AzureKeyVaultKeyRemoval.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageAccount.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 77d5846727..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Removes a Key Vault managed Azure Storage Account and all associated SAS definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Disassociates an Azure Storage Account from Key Vault. This does not remove an Azure Storage Account but removes the account keys from being managed by Azure Key Vault. All associated Key Vault managed Storage SAS definitions are also removed. - -## EXAMPLES - -### Example 1: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions. -``` -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -``` - -Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. - -### Example 2: Remove a Key Vault managed Azure Storage Account and all associated SAS definitions without user confirmation. -``` -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -Force -Confirm:$False -``` - -Disassociates Azure Storage Account 'mystorageaccount' from Key Vault 'myvault' and stops Key Vault from managing its keys. The account 'mystorageaccount' will not be removed. All Key Vault managed Storage SAS definitions associated with this account will be removed. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -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 -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index 42c9e352da..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Removes a Key Vault managed Azure Storage SAS definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a Key Vault managed Azure Storage SAS definitions. This also removes the secret used to get the SAS token per this SAS definition. - -## EXAMPLES - -### Example 1: Remove a Key Vault managed Azure Storage SAS definition. -``` -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -``` - -Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. - -### Example 2: Remove a Key Vault managed Azure Storage SAS definition without user confirmation. -``` -PS C:\> Remove-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -Force -Confirm:$False -``` - -Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'. - -## PARAMETERS - -### -AccountName -Storage account name. -Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -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 -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Storage sas definition name. -Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultSecret.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultSecret.md deleted file mode 100644 index f30675477b..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureKeyVaultSecret.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurekeyvaultsecret -schema: 2.0.0 ---- - -# Remove-AzureKeyVaultSecret - -## SYNOPSIS -Deletes a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-Force] [-PassThru] [-InRemovedState] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureKeyVaultSecret cmdlet deletes a secret in a key vault. -If the secret was accidentally deleted the secret can be recovered using Undo-AzureKeyVaultSecretRemoval by a user with special 'recover' permissions. -This cmdlet has a value of high for the **ConfirmImpact** property. - -## EXAMPLES - -### Example 1: Remove a secret from a key vault -``` -PS C:\>Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -``` - -This command removes the secret named FinanceSecret from the key vault named Contoso.' - -### Example 2: Remove a secret from a key vault without user confirmation -``` -PS C:\>Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -Force -Confirm:$False -``` - -This command removes the secret named FinanceSecret from the key vault named Contoso. -The command specifies the *Force* and *Confirm* parameters, and, therefore, the cmdlet does not prompt you for confirmation. - -### Example 3: Purge deleted secret from the key vault permanently -``` -PS C:\>Remove-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState -``` - -This command premoves the secret named FinanceSecret from the key vault named Contoso permanently. -Executing this cmdlet requires the 'purge' permission, which must have been previously and explicitly granted to the user for this key vault. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -If present, removes the previously deleted secret permanently. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a secret. -This cmdlet constructs the fully qualified domain name (FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns a **Microsoft.Azure.Commands.KeyVault.Models.Secret** object. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which the secret belongs. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.DeletedSecret -This cmdlet returns a value only if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Undo-AzureKeyVaultSecretRemoval](./Undo-AzureKeyVaultSecretRemoval.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVault.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVault.md deleted file mode 100644 index 90f5b8ea09..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVault.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 7A929BA8-02D9-4BBE-AFF3-B8781F8DDAD9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurermkeyvault -schema: 2.0.0 ---- - -# Remove-AzureRmKeyVault - -## SYNOPSIS -Deletes a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByAvailableVault -``` -Remove-AzureRmKeyVault [-VaultName] <String> [[-ResourceGroupName] <String>] [[-Location] <String>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByDeletedVault -``` -Remove-AzureRmKeyVault [-VaultName] <String> [-Location] <String> [-Force] [-InRemovedState] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmKeyVault** cmdlet deletes the specified key vault. -It also deletes all keys and secrets contained in that instance. - -Note that although specifying the resource group is optional for this cmdlet, you should so for better performance. - -## EXAMPLES - -### Example 1: Remove a key vault -``` -PS C:\>Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -``` - -This command removes the key vault named Contoso03Vault from your current subscription. - -### Example 2: Remove a key vault from a specified resource group -``` -PS C:\>Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -ResourceGroupName "Group14" -``` - -This command removes the key vault named Contoso03Vault from the named resource group. -If you do not specify the resource group name, the cmdlet searches for the named key vault to delete in your current subscription. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that the cmdlet does not prompt you for confirmation. -By default, this cmdlet prompts you to confirm that you want to delete the key vault. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InRemovedState -Remove the previously deleted vault permanently. - -```yaml -Type: SwitchParameter -Parameter Sets: ByDeletedVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the deleted vault. - -```yaml -Type: String -Parameter Sets: ByAvailableVault -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ByDeletedVault -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: ByAvailableVault -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVaultAccessPolicy.md b/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVaultAccessPolicy.md deleted file mode 100644 index 102136523b..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Remove-AzureRmKeyVaultAccessPolicy.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: AE7B103B-23ED-4A66-A0DC-14FB0DF38FA8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/remove-azurermkeyvaultaccesspolicy -schema: 2.0.0 ---- - -# Remove-AzureRmKeyVaultAccessPolicy - -## SYNOPSIS -Removes all permissions for a user or application from a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByServicePrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -ServicePrincipalName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByUserPrincipalName -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -UserPrincipalName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByObjectId -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> - [-ApplicationId <Guid>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByEmail -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ForVault -``` -Remove-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmKeyVaultAccessPolicy** cmdlet removes all permissions for a user or application or for all users and applications from a key vault. -Even if you remove all permissions, the owner of the Azure subscription that contains the key vault can add permissions to the key vault. - -Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. - -## EXAMPLES - -### Example 1: Remove permissions for a user -``` -PS C:\>Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -``` - -This command removes all the permissions that a user PattiFuller@contoso.com has on the key vault named Contoso03Vault. - -### Example 2: Remove permissions for an application -``` -PS C:\>Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -``` - -This command removes all the permissions that an application has on the key vault named Contoso03Vault. -This example identifies the application by using the service principal name registered in Azure Active Directory, `http://payroll.contoso.com`. - -### Example 3: Remove permissions for an application by using its object ID -``` -PS C:\>Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectID 34595082-9346-41b6-8d6b-295a2808b8db -``` - -This command removes all the permissions that an application has on the key vault named Contoso03Vault. -This example identifies the application by the object ID of the service principal. - -### Example 4: Remove permissions for the Microsoft.Compute resource provider -``` -PS C:\>Remove-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment -``` - -This command removes permission for the Microsoft.Compute resource provider to get secrets from the Contoso03Vault. - -## PARAMETERS - -### -ApplicationId -For future use. - -```yaml -Type: Guid -Parameter Sets: ByObjectId -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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user email address of the user whose access you want to remove. - -```yaml -Type: String -Parameter Sets: ByEmail -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDeployment -Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this key vault is referenced in resource creation, for example when creating a virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the object ID of the user or service principal in Azure Active Directory for which to remove permissions. - -```yaml -Type: String -Parameter Sets: ByObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group associated with the key vault whose access policy is being modified. -If not specified, this cmdlet searches for the key vault in the current subscription. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -Specifies the service principal name of the application whose permissions you want to remove. -Specify the application ID, also known as client ID, registered for the application in Azure Active Directory. - -```yaml -Type: String -Parameter Sets: ByServicePrincipalName -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -Specifies the user principal name of the user whose access you want to remove. - -```yaml -Type: String -Parameter Sets: ByUserPrincipalName -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. -This cmdlet removes permissions for the key vault that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSVault - -## NOTES - -## RELATED LINKS - -[Set-AzureRmKeyVaultAccessPolicy](./Set-AzureRmKeyVaultAccessPolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultKey.md deleted file mode 100644 index aa967ff127..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultKey.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: C4E7ACDF-22FB-4D49-93B3-69E787B7E0CD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultkey -schema: 2.0.0 ---- - -# Restore-AzureKeyVaultKey - -## SYNOPSIS -Creates a key in a key vault from a backed-up key. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restore-AzureKeyVaultKey [-VaultName] <String> [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultKey** cmdlet creates a key in the specified key vault. -This key is a replica of the backed-up key in the input file and has the same name as the original key. -If the key vault already has a key by the same name, this cmdlet fails instead of overwriting the original key. -If the backup contains multiple versions of a key, all versions are restored. - -The key vault that you restore the key into can be different from the key vault that you backed up the key from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up key -``` -PS C:\>Restore-AzureKeyVaultKey -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" -``` - -This command restores a key, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. - -## 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 -Specifies the input file that contains the backup of the key to restore. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault into which to restore the key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyBundle - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Backup-AzureKeyVaultKey](./Backup-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultSecret.md b/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultSecret.md deleted file mode 100644 index 8ee37fd6ee..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Restore-AzureKeyVaultSecret.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 70DB088D-4AF5-406B-8D66-118A0F766041 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/restore-azurekeyvaultsecret -schema: 2.0.0 ---- - -# Restore-AzureKeyVaultSecret - -## SYNOPSIS -Creates a secret in a key vault from a backed-up secret. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Restore-AzureKeyVaultSecret [-VaultName] <String> [-InputFile] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureKeyVaultSecret** cmdlet creates a secret in the specified key vault. -This secret is a replica of the backed-up secret in the input file and has the same name as the original secret. -If the key vault already has a secret by the same name, this cmdlet fails instead of overwriting the original secret. -If the backup contains multiple versions of a secret, all versions are restored. - -The key vault that you restore the secret into can be different from the key vault that you backed up the secret from. -However, the key vault must use the same subscription and be in an Azure region in the same geography (for example, North America). -See the Microsoft Azure Trust Center (https://azure.microsoft.com/support/trust-center/) for the mapping of Azure regions to geographies. - -## EXAMPLES - -### Example 1: Restore a backed-up secret -``` -PS C:\>Restore-AzureKeyVaultSecret -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob" -``` - -This command restores a secret, including all of its versions, from the backup file named Backup.blob into the key vault named MyKeyVault. - -## 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 -Specifies the input file that contains the backup of the secret to restore. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault into which to restore the secret. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.Secret - -## NOTES - -## RELATED LINKS - -[Set-AzureKeyVaultSecret](./Set-AzureKeyVaultSecret.md) - -[Backup-AzureKeyVaultSecret](./Backup-AzureKeyVaultSecret.md) - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateAttribute.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateAttribute.md deleted file mode 100644 index d276225c9e..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateAttribute.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 3BD243C7-A40E-4061-93FF-DDE7DECAD0A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultcertificateattribute -schema: 2.0.0 ---- - -# Set-AzureKeyVaultCertificateAttribute - -## SYNOPSIS -Modifies editable attributes of a certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureKeyVaultCertificateAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-Enable <Boolean>] [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultCertificateAttribute** cmdlet modifies the editable attributes of a certificate. - -## EXAMPLES - -### Example 1: Modify the tags associated with a certificate -``` -PS C:\>$Tags = @{ "Team" = "Azure" ; "Role" = "Engg" } -PS C:\> Set-AzureKeyVaultCertificateAttribute -VaultName "ContosoKV01" -Name "TestCert01" -Tag $Tags -PS C:\> Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01" -Name : "TestCert01" -Certificate : [Subject] - CN=AZURE - - [Issuer] - CN=AZURE - - [Serial Number] - 5A2EF60501F241D6A4336841B36FEA41 - - [Not Before] - 7/27/2016 6:50:01 PM - - [Not After] - 7/27/2018 7:00:01 PM - - [Thumbprint] - A565D568082FEE2BE33B356ECC3703C2E9886555 - -Id : https://ContosoKV01.vault.azure.net:443/certificates/tt02 -KeyId : https://ContosoKV01.vault.azure.net:443/keys/tt02 -SecretId : https://ContosoKV01.vault.azure.net:443/secrets/tt02 -Thumbprint : A565D568082FEE2BE33B356ECC3703C2E9886555 -Tags : {[Role, Engg], [Team, Azure]} -Enabled : True -Created : 7/28/2016 2:00:01 AM -Updated : 8/1/2016 5:37:48 PM -``` - -The first command assigns an array of key/value pairs to the $Tags variable. - -The second command sets the tags value of the certificate named TestCert01 to be $Tags. - -The final command displays the TestCert01 certificate by using the Get-AzureKeyVaultCertificate cmdlet to verify the operation. - -## 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 -``` - -### -Enable -Indicates whether to enable or disable a certificate. -Specify $True to enable or $False to disable. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate to modify. This cmdlet constructs the FQDN of a certificate -based on the key vault name, your currently selected environment, the certificate name, and the -certificate version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the key vault name in which this cmdlet modifies a certificate. -This cmdlet constructs the FQDN of a key vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of a certificate. -This cmdlet constructs the FQDN of a certificate based on the key vault name, your currently selected environment, the certificate name, and the certificate version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateVersion - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultCertificate](./Add-AzureKeyVaultCertificate.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateIssuer.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateIssuer.md deleted file mode 100644 index 194640d464..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificateIssuer.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 4C2C77F7-ECE4-4106-8AF1-256A496A977B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultcertificateissuer -schema: 2.0.0 ---- - -# Set-AzureKeyVaultCertificateIssuer - -## SYNOPSIS -Sets a certificate issuer in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Expanded (Default) -``` -Set-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> [-IssuerProvider <String>] - [-AccountId <String>] [-ApiKey <SecureString>] [-OrganizationDetails <KeyVaultCertificateOrganizationDetails>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByValue -``` -Set-AzureKeyVaultCertificateIssuer [-VaultName] <String> [-Name] <String> -Issuer <KeyVaultCertificateIssuer> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureKeyVaultCertificateIssuer cmdlet sets a certificate issuer in a key vault. - -## EXAMPLES - -### Example 1: Set a certificate issuer -``` -PS C:\>$Issuer = Set-AzureKeyVaultCertificateIssuer -VaultName "Contosokv01" -Name "TestIssuer01" -IssuerProvider "Test" -AccountId "555" -ApiKey $Password -OrganizationDetails $OrgDetails -PassThru -``` - -This command sets the properties for a certificate issuer, and then stores it in the $Issuer variable. - -## PARAMETERS - -### -AccountId -Specifies the account ID for the certificate issuer. - -```yaml -Type: String -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiKey -Specifies the API key for the certificate issuer. - -```yaml -Type: SecureString -Parameter Sets: Expanded -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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Issuer -Specifies the certificate issuer to update. - -```yaml -Type: KeyVaultCertificateIssuer -Parameter Sets: ByValue -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuerProvider -Specifies the type of certificate issuer. - -```yaml -Type: String -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Issuer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IssuerName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OrganizationDetails -Organization details to be used with the issuer. - -```yaml -Type: KeyVaultCertificateOrganizationDetails -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateIssuer](./Get-AzureKeyVaultCertificateIssuer.md) - -[Remove-AzureKeyVaultCertificateIssuer](./Remove-AzureKeyVaultCertificateIssuer.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificatePolicy.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificatePolicy.md deleted file mode 100644 index e292b36913..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultCertificatePolicy.md +++ /dev/null @@ -1,426 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 28BC1B99-946C-4A8D-9581-4D5CC0BCEF8B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultcertificatepolicy -schema: 2.0.0 ---- - -# Set-AzureKeyVaultCertificatePolicy - -## SYNOPSIS -Creates or updates the policy for a certificate in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Expanded (Default) -``` -Set-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> [-SecretContentType <String>] - [-ReuseKeyOnRenewal <Boolean>] [-Disabled] [-SubjectName <String>] - [-DnsNames <System.Collections.Generic.List`1[System.String]>] - [-KeyUsage <System.Collections.Generic.List`1[System.String]>] - [-Ekus <System.Collections.Generic.List`1[System.String]>] [-ValidityInMonths <Int32>] [-IssuerName <String>] - [-CertificateType <String>] [-RenewAtNumberOfDaysBeforeExpiry <Int32>] [-RenewAtPercentageLifetime <Int32>] - [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] [-KeyType <String>] - [-KeyNotExportable] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByValue -``` -Set-AzureKeyVaultCertificatePolicy [-VaultName] <String> [-Name] <String> - [-EmailAtNumberOfDaysBeforeExpiry <Int32>] [-EmailAtPercentageLifetime <Int32>] [-KeyType <String>] - [[-CertificatePolicy] <KeyVaultCertificatePolicy>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultCertificatePolicy** cmdlet creates or updates the policy for a certificate in a key vault. - -## EXAMPLES - -### Example 1: Set a certificate policy -``` -PS C:\>Set-AzureKeyVaultCertificatePolicy -VaultName "ContosoKV01" -Name "TestCert01" -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -IssuerName "Self" -ValidityInMonths 6 -ReuseKeyOnRenewal $True -``` - -This command sets the policy for the TestCert01 certificate in the ContosoKV01 key vault. - -## PARAMETERS - -### -CertificatePolicy -Specifies the certificate policy. - -```yaml -Type: KeyVaultCertificatePolicy -Parameter Sets: ByValue -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateType -Specifies the type of certificate to the issuer. - -```yaml -Type: String -Parameter Sets: Expanded -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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the certificate policy is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsNames -Specifies the DNS names in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ekus -Specifies the enhanced key usages (EKUs) in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtNumberOfDaysBeforeExpiry -Specifies how many days before expiry the automatic notification process begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for the notification begins. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuerName -Specifies the name of the issuer for this certificate. - -```yaml -Type: String -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyNotExportable -Indicates that the key is not exportable. - -```yaml -Type: SwitchParameter -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyType -Specifies the key type of the key that backs the certificate. -The acceptable values for this parameter are: - -- RSA -- RSA-HSM - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: RSA, RSA-HSM - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyUsage -Specifies the key usages in the certificate. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RenewAtNumberOfDaysBeforeExpiry -Specifies the number of days before expiry after which the automatic process for certificate renewal begins. - -```yaml -Type: Int32 -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RenewAtPercentageLifetime -Specifies the percentage of the lifetime after which the automatic process for certificate renewal begins. - -```yaml -Type: Int32 -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReuseKeyOnRenewal -Indicates that the certificate reuse the key during renewal. - -```yaml -Type: Boolean -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretContentType -Specifies the content type of the new key vault secret. -The acceptable values for this parameter are: - -- application/x-pkcs12 -- application/x-pem-file - -```yaml -Type: String -Parameter Sets: Expanded -Aliases: -Accepted values: application/x-pkcs12, application/x-pem-file - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubjectName -Specifies the subject name of the certificate. - -```yaml -Type: String -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidityInMonths -Specifies the number of months the certificate is valid. - -```yaml -Type: Int32 -Parameter Sets: Expanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificatePolicy - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificatePolicy](./Get-AzureKeyVaultCertificatePolicy.md) - -[New-AzureKeyVaultCertificatePolicy](./New-AzureKeyVaultCertificatePolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultKeyAttribute.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultKeyAttribute.md deleted file mode 100644 index 4e31e2ba7c..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultKeyAttribute.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultkeyattribute -schema: 2.0.0 ---- - -# Set-AzureKeyVaultKeyAttribute - -## SYNOPSIS -Updates the attributes of a key in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureKeyVaultKeyAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-Enable <Boolean>] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-KeyOps <String[]>] [-Tag <Hashtable>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultKeyAttribute** cmdlet updates the editable attributes of a key in a key vault. - -## EXAMPLES - -### Example 1: Modify a key to enable it, and set the expiration date and tags -``` -PS C:\>$Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = null} -PS C:\> Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru -``` - -The first command creates a **DateTime** object by using the **Get-Date** cmdlet. That object -specifies a time two years in the future. The command stores that date in the $Expires variable. -For more information, type `Get-Help Get-Date`. - -The second command creates a variable to store tag values of high severity and Accounting. - -The final command modifies a key named ITSoftware. The command enables the key, sets its expiration -time to the time stored in $Expires, and sets the tags that are stored in $Tags. - -### Example 2: Modify a key to delete all tags -``` -PS C:\>Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Version '7EEA45C6EE50490B9C3176F80AC1A0DG' -Tag @{} -``` - -This commands deletes all tags for a specific version of a key named ITSoftware. - -## 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 -``` - -### -Enable -Specifies whether to enable or disable a key. A value of $True enables the key. A value of $False -disables the key. If you do not specify this parameter, this cmdlet does not modify the status of -the key. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the expiration time, as a **DateTime** object, for the key that this cmdlet updates. This -parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the -**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyOps -Specifies an array of operations that can be performed by using the key that this cmdlet adds. -If you do not specify this parameter, all operations can be performed. - -The acceptable values for this parameter are a comma-separated list of key operations as defined by -the JSON Web Key specification. These values (case-sensitive) are: - -- encrypt -- decrypt -- wrap -- unwrap -- sign -- verify -- backup -- restore - -```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 key to update. This cmdlet constructs the fully qualified domain name -(FQDN) of a key based on the name that this parameter specifies, the name of the key vault, and -your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the time, as a **DateTime** object, before which the key cannot be used. -This parameter uses UTC. -To obtain a **DateTime** object, use the **Get-Date** cmdlet. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault in which this cmdlet modifies the key. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the key version. -This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key name, and the key version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: KeyVersion - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyBundle - -## NOTES - -## RELATED LINKS - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultManagedStorageSasDefinition.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultManagedStorageSasDefinition.md deleted file mode 100644 index 74553e6e63..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultManagedStorageSasDefinition.md +++ /dev/null @@ -1,628 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultmanagedstoragesasdefinition -schema: 2.0.0 ---- - -# Set-AzureKeyVaultManagedStorageSasDefinition - -## SYNOPSIS -Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RawSas (Default) -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Parameter] <Hashtable> [-Disable] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AdhocAccountSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition -Service <String[]> -ResourceType <String[]> - [-ApiVersion <String>] [-VaultName] <String> [-AccountName] <String> [-Name] <String> [-Disable] - [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] [-IPAddressOrRange <String>] - -ValidityPeriod <TimeSpan> -Permission <String[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AdhocServiceBlobSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> -Blob <String> - -Container <String> [-SharedAccessHeader <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AdhocServiceContainerSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> -Container <String> - [-SharedAccessHeader <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### AdhocServiceFileSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> - [-SharedAccessHeader <String[]>] -Share <String> -Path <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AdhocServiceShareSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> - [-SharedAccessHeader <String[]>] -Share <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### AdhocServiceQueueSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> -Queue <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### AdhocServiceTableSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -ValidityPeriod <TimeSpan> -Permission <String[]> -Table <String> - [-StartPartitionKey <String>] [-StartRowKey <String>] [-EndPartitionKey <String>] [-EndRowKey <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StoredPolicyServiceBlobSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Blob <String> -Container <String> -Policy <String> - [-SharedAccessHeader <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### StoredPolicyServiceContainerSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Container <String> -Policy <String> [-SharedAccessHeader <String[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StoredPolicyServiceFileSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Policy <String> [-SharedAccessHeader <String[]>] -Share <String> -Path <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StoredPolicyServiceShareSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Policy <String> [-SharedAccessHeader <String[]>] -Share <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StoredPolicyServiceQueueSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Policy <String> -Queue <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StoredPolicyServiceTableSas -``` -Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] <String> [-AccountName] <String> [-Name] <String> - [-Disable] [-Tag <Hashtable>] [-TargetStorageVersion <String>] [-Protocol <String>] - [-IPAddressOrRange <String>] -Policy <String> -Table <String> [-StartPartitionKey <String>] - [-StartRowKey <String>] [-EndPartitionKey <String>] [-EndRowKey <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Sets a Shared Access Signature (SAS) definition with a given Key Vault managed Azure Storage -Account. This also sets a secret which can be used to get the SAS token per this SAS definition. -SAS token is generated using these parameters and the active key of the Key Vault managed Azure -Storage Account. - -## EXAMPLES - -### Example 1 : Set an ad hoc service Blob sas definition -``` -PS C:\> Set-AzureKeyVaultManagedStorageSasDefinition -Blob 'blob1' -Container 'container1' -VaultName 'vault1' -AccountName 'account1' -Name 'sas1' -ValidityPeriod ([System.Timespan]::FromDays(30)) -Permission Read,Add -SharedAccessHeader CacheControl,ContentDisposition -Protocol HttpsOnly -IPAddressOrRange '168.1.5.60-168.1.5.70' -``` - -Sets an ad hoc service blob sas definition 'sas1' with key vault managed storage account 'account1' in vault 'vault1'. - -### Example 2 : Set an ad hoc account sas definition -``` -PS C:\> Set-AzureKeyVaultManagedStorageSasDefinition -Service Blob,File -ResourceType Container,Service -VaultName 'vault1' -AccountName 'account1' -Name 'sas1' -Protocol HttpsOrHttp -IPAddressOrRange '168.1.5.60' -ValidityPeriod ([System.Timespan]::FromDays(30)) -Permission Read,Add -``` - -Sets an ad hoc blob sas definition 'sas1' with key vault managed storage account 'account1' in vault 'vault1'. - -### Example 3 : Set a sas definition using a hashtable -``` -PS C:\> $parameters = @{"sasType"="blob";"signedVersion"="2016-05-31";"signedProtocols"="https";"signedIp"="168.1.5.60-168.1.5.70";"validityPeriod"="P30D";"signedPermissions"="ra";"blobName"="blob1";"containerName"="container1";"rscd"="";"rscc"=""} -PS C:\> Set-AzureKeyVaultManagedStorageSasDefinition -VaultName vault1 -AccountName account1 -Name sas1 -Parameter $parameters -``` - -Sets an ad hoc blob sas definition 'sas1' with key vault managed storage account 'account1' in -vault 'vault1' using a hashtable. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApiVersion -Specifies the storage service version to use to execute the request made using the account SAS URI. - -```yaml -Type: String -Parameter Sets: AdhocAccountSas -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Blob -Blob Name - -```yaml -Type: String -Parameter Sets: AdhocServiceBlobSas, StoredPolicyServiceBlobSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Container -Container Name - -```yaml -Type: String -Parameter Sets: AdhocServiceBlobSas, AdhocServiceContainerSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Disables the use of sas definition for generation of sas token. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndPartitionKey -End Partition Key - -```yaml -Type: String -Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: endpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRowKey -End Row Key - -```yaml -Type: String -Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: endrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -IP, or IP range ACL (access control list) of the request that would be accepted by Azure Storage. - -```yaml -Type: String -Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Storage sas definition name. Cmdlet constructs the FQDN of a storage sas definition from vault -name, currently selected environment, storage account name and sas definition name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SasDefinitionName - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -Sas definition parameters that will be used to create the sas token. - -```yaml -Type: Hashtable -Parameter Sets: RawSas -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Path to the cloud file to generate sas token against. - -```yaml -Type: String -Parameter Sets: AdhocServiceFileSas, StoredPolicyServiceFileSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Permission -Permission. Values include 'Query','Add','Update','Process' - -```yaml -Type: String[] -Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas -Aliases: -Accepted values: Add, Create, Delete, List, Process, Read, Query, Update, Write - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Policy Identifier - -```yaml -Type: String -Parameter Sets: StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Protocol can be used in the request with the SAS token. - -```yaml -Type: String -Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: -Accepted values: HttpsOnly, HttpsOrHttp - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Queue Name - -```yaml -Type: String -Parameter Sets: AdhocServiceQueueSas, StoredPolicyServiceQueueSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -Resource types that this SAS token applies to. Values include 'Service','Container','Object' - -```yaml -Type: String[] -Parameter Sets: AdhocAccountSas -Aliases: -Accepted values: Service, Container, Object - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Service types that this SAS token applies to. Values include 'Blob','File','Queue','Table' - -```yaml -Type: String[] -Parameter Sets: AdhocAccountSas -Aliases: -Accepted values: Blob, File, Queue, Table - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Share -Share Name - -```yaml -Type: String -Parameter Sets: AdhocServiceFileSas, AdhocServiceShareSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedAccessHeader -Specifies the query parameters to override response headers. - -```yaml -Type: String[] -Parameter Sets: AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas -Aliases: -Accepted values: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentType - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartPartitionKey -Start Partition Key - -```yaml -Type: String -Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: startpk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartRowKey -Start Row Key - -```yaml -Type: String -Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: startrk - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Table -Table Name - -```yaml -Type: String -Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetStorageVersion -Specifies the signed storage service version to use to authenticate requests made with the SAS token. - -```yaml -Type: String -Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidityPeriod -Validity period that will get used to set the expiry time of sas token from the time it gets generated - -```yaml -Type: TimeSpan -Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageSasDefinition - -## NOTES - -## RELATED LINKS - -[Azure​RM.​Key​Vault](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecret.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecret.md deleted file mode 100644 index 5c63ac9742..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecret.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 9FC72DE9-46BB-4CB5-9880-F53756DBE012 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultsecret -schema: 2.0.0 ---- - -# Set-AzureKeyVaultSecret - -## SYNOPSIS -Creates or updates a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureKeyVaultSecret [-VaultName] <String> [-Name] <String> [-SecretValue] <SecureString> [-Disable] - [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultSecret** cmdlet creates or updates a secret in a key vault in Azure Key -Vault. If the secret does not exist, this cmdlet creates it. If the secret already exists, this -cmdlet creates a new version of that secret. - -## EXAMPLES - -### Example 1: Modify the value of a secret using default attributes -``` -PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> Set-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help -ConvertTo-SecureString`. - -The second command modifies value of the secret named ITSecret in the key vault named Contoso. The -secret value becomes the value stored in $Secret. - -### Example 2: Modify the value of a secret using custom attributes -``` -PS C:\> $Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $NBF =(Get-Date).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'medium'; 'IT' = null } -PS C:\> $ContentType = 'txt' -PS C:\> Set-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable $False -Tags $Tags -``` - -The first command converts a string into a secure string by using the **ConvertTo-SecureString** -cmdlet, and then stores that string in the $Secret variable. For more information, type `Get-Help -ConvertTo-SecureString`. - -The next commands define custom attributes for the expiry date, tags, and context type, and store -the attributes in variables. - -The final command modifies values of the secret named ITSecret in the key vault named Contoso, by -using the values specified previously as variables. - -## PARAMETERS - -### -ContentType -Specifies the content type of a secret. -To delete the existing content type, specify an empty string. - -```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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Indicates that this cmdlet disables a secret. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the expiration time, as a **DateTime** object, for the secret that this cmdlet updates. -This parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object, use the -**Get-Date** cmdlet. For more information, type `Get-Help Get-Date`. - -```yaml -Type: DateTime -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 a secret to modify. This cmdlet constructs the fully qualified domain name -(FQDN) of a secret based on the name that this parameter specifies, the name of the key vault, and -your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the time, as a **DateTime** object, before which the secret cannot be used. This -parameter uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretValue -Specifies the value for the secret as a **SecureString** object. To obtain a **SecureString** -object, use the **ConvertTo-SecureString** cmdlet. For more information, type `Get-Help -ConvertTo-SecureString`. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to which this secret belongs. This cmdlet constructs the FQDN -of a key vault based on the name that this parameter specifies and your current environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.Secret - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecretAttribute.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecretAttribute.md deleted file mode 100644 index b610fef306..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureKeyVaultSecretAttribute.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: E2A45461-6B41-42FF-A874-A4CEFC867A33 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurekeyvaultsecretattribute -schema: 2.0.0 ---- - -# Set-AzureKeyVaultSecretAttribute - -## SYNOPSIS -Updates attributes of a secret in a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureKeyVaultSecretAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] - [-Enable <Boolean>] [-Expires <DateTime>] [-NotBefore <DateTime>] [-ContentType <String>] [-Tag <Hashtable>] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureKeyVaultSecretAttribute** cmdlet updates editable attributes of a secret in a key vault. - -## EXAMPLES - -### Example 1: Modify the attributes of a secret -``` -PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime() -PS C:\> $Nbf = (Get-Date).ToUniversalTime() -PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = null} -PS C:\> $ContentType= 'xml' -PS C:\> Set-AzureKeyVaultSecretAttribute -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru -``` - -The first four commands define attributes for the expiry date, the NotBefore date, tags, and -context type, and store the attributes in variables. - -The final command modifies the attributes for the secret named HR in the key vault named -ContosoVault, using the stored variables. - -### Example 2: Delete the tags and content type for a secret -``` -PS C:\>Set-AzureKeyVaultSecretAttribute -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{} -``` - -This command deletes the tags and the content type for the specified version of the secret named HR -in the key vault named Contoso. - -### Example 3: Disable the current version of secrets whose name begins with IT -``` -PS C:\> $Vault = 'ContosoVault' -PS C:\> $Prefix = 'IT' -PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Set-AzureKeyVaultSecretAttribute -Enable $False -``` - -The first command stores the string value Contoso in the $Vault variable. - -The second command stores the string value IT in the $Prefix variable. - -The third command uses the Get-AzureKeyVaultSecret cmdlet to get the secrets in the specified key -vault, and then passes those secrets to the **Where-Object** cmdlet. The **Where-Object** cmdlet -filters the secrets for names that begin with the characters IT. The command pipes the secrets that -match the filter to the Set-AzureKeyVaultSecretAttribute cmdlet, which disables them. - -### Example 4: Set the ContentType for all versions of a secret -``` -PS C:\>$VaultName = 'ContosoVault' -PS C:\> $Name = 'HR' -PS C:\> $ContentType = 'xml' -PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Set-AzureKeyVaultSecretAttribute -ContentType $ContentType -``` - -The first three commands define string variables to use for the *VaultName*, *Name*, and -*ContentType* parameters. The fourth command uses the Get-AzureKeyVaultKey cmdlet to get the -specified keys, and pipes the keys to the Set-AzureKeyVaultSecretAttribute cmdlet to set their -content type to XML. - -## PARAMETERS - -### -ContentType -Specifies the content type of a secret. If you do not specify this parameter, there is no change to -the current secret's content type. To remove the existing content type, specify an empty string. - -```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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Indicates whether to enable a secret. Specify $False to disable a secret, or $True to enable a -secret. If you do not specify this parameter, there is no change to the current secret's enabled or -disabled state. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expires -Specifies the date and time that a secret expires. - -```yaml -Type: DateTime -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 a secret. This cmdlet constructs the fully qualified domain name (FQDN) of a -secret based on the name that this parameter specifies, the name of the key vault, and your current -environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotBefore -Specifies the Coordinated Universal Time (UTC) before which the secret can't be used. -If you do not specify this parameter, there is no change to the current secret's NotBefore attribute. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of the key vault to modify. -This cmdlet constructs the FQDN of a key vault based on the name that this parameter specifies, and your currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of a secret. -This cmdlet constructs the FQDN of a secret based on the key vault name, your currently selected environment, the secret name, and the secret version. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SecretVersion - -Required: False -Position: 2 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.Secret -Returns Microsoft.Azure.Commands.KeyVault.Models.Secret object if PassThru is specified. Otherwise, returns nothing. - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureRmKeyVaultAccessPolicy.md b/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureRmKeyVaultAccessPolicy.md deleted file mode 100644 index 11e58ca050..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Set-AzureRmKeyVaultAccessPolicy.md +++ /dev/null @@ -1,518 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 636FAD5B-8C39-4E5C-8978-6845C6B89BC0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/set-azurermkeyvaultaccesspolicy -schema: 2.0.0 ---- - -# Set-AzureRmKeyVaultAccessPolicy - -## SYNOPSIS -Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByServicePrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -ServicePrincipalName <String> [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByUserPrincipalName -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] - -UserPrincipalName <String> [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByObjectId -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -ObjectId <String> - [-ApplicationId <Guid>] [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] - [-PermissionsToCertificates <String[]>] [-PermissionsToStorage <String[]>] [-BypassObjectIdValidation] - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByEmailAddress -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] -EmailAddress <String> - [-PermissionsToKeys <String[]>] [-PermissionsToSecrets <String[]>] [-PermissionsToCertificates <String[]>] - [-PermissionsToStorage <String[]>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ForVault -``` -Set-AzureRmKeyVaultAccessPolicy [-VaultName] <String> [[-ResourceGroupName] <String>] [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmKeyVaultAccessPolicy** cmdlet grants or modifies existing permissions for a user, application, or security group to perform the specified operations with a key vault. It does not modify the permissions that other users, applications, or security groups have on the key vault. - -If you are setting permissions for a security group, this operation affects only users in that security group. - -The following directories must all be the same Azure directory: -- The default directory of the Azure subscription in which the key vault resides. -- The Azure directory that contains the user or application group that you are granting permissions to. - -Examples of scenarios when these conditions are not met and this cmdlet will not work are: - -- Authorizing a user from a different organization to manage your key vault. -Each organization has its own directory. -- Your Azure account has multiple directories. -If you register an application in a directory other than the default directory, you cannot authorize that application to use your key vault. -The application must be in the default directory. - -Note that although specifying the resource group is optional for this cmdlet, you should do so for better performance. - -## EXAMPLES - -### Example 1: Grant permissions to a user for a key vault and modify the permissions -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys create,import,delete,list -PermissionsToSecrets 'set,delete' -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets set,delete,get -PassThru -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys @() -PassThru -``` - -The first command grants permissions for a user in your Azure Active Directory, PattiFuller@contoso.com, to perform operations on keys and secrets with a key vault named Contoso03Vault. - -The second command modifies the permissions that were granted to PattiFuller@contoso.com in the first command, to now allow getting secrets in addition to setting and deleting them. The permissions to key operations remain unchanged after this command. The *PassThru* parameter results in the updated object being returned by the cmdlet. - -The final command further modifies the existing permissions for PattiFuller@contoso.com to remove all permissions to key operations. The permissions to secret operations remain unchanged after this command. The *PassThru* parameter results in the updated object being returned by the cmdlet. - -### Example 2: Grant permissions for an application service principal to read and write secrets -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -PermissionsToSecrets Get,Set -``` - -This command grants permissions for an application for a key vault named Contoso03Vault. - -The *ServicePrincipalName* parameter specifies the application. The application must be registered in your Azure Active Directory. The value of the *ServicePrincipalName* parameter must be either the service principal name of the application or the application ID GUID. - -This example specifies the service principal name `http://payroll.contoso.com`, and the command grants the application permissions to read and write secrets. - -### Example 3: Grant permissions for an application using its object ID -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectId 34595082-9346-41b6-8d6b-295a2808b8db -PermissionsToSecrets Get,Set -``` - -This command grants the application permissions to read and write secrets. - -This example specifies the application using the object ID of the service principal of the application. - -### Example 4: Grant permissions for a user principal name -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets Get,List,Set -``` - -This command grants get, list, and set permissions for the specified user principal name for access to secrets. - -### Example 5: Enable secrets to be retrieved from a key vault by the Microsoft.Compute resource provider -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment -``` - -This command grants the permissions for secrets to be retrieved from the Contoso03Vault key vault by the Microsoft.Compute resource provider. - -### Example 6: Grant permissions to a security group -``` -PS C:\>Get-AzureRmADGroup -PS C:\> Set-AzureRmKeyVaultAccessPolicy -VaultName 'myownvault' -ObjectId (Get-AzureRmADGroup -SearchString 'group2')[0].Id -PermissionsToKeys All -PermissionsToSecrets All -DisplayName Type ObjectId ------------ ---- -------- -group1 96a0daa6-9841-4a9c-bdeb-e7062276c688 -group2 b8a401eb-63ad-4a30-b0e1-a7461969fe54 -group3 da07a6be-2c1e-4e42-934d-ceb57cf652b4 -``` - -The first command uses the Get-AzureRmADGroup cmdlet to get all Active Directory groups. From the output, you see 3 groups returned, named **group1**, **group2**, and **group3**. Multiple groups can have the same name but always have a unique ObjectId. When more than one group that has the same name is returned, use the ObjectId in the output to identify the one you want to use. - -You then use the output of this command with Set-AzureRmKeyVaultAccessPolicy to grant permissions to group2 for your key vault, named **myownvault**. This example enumerates the groups named 'group2' inline in the same command line. - -There may be multiple groups in the returned list that are named 'group2'. -This example picks the first one, indicated by index \[0\] in the returned list. - -### Example 7: Grant Azure Information Protection access to the customer-managed tenant key (BYOK) -``` -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName 'Contoso04Vault' -ServicePrincipalName 00000012-0000-0000-c000-000000000000 -PermissionsToKeys decrypt,sign,get -``` - -This command authorizes Azure Information Protection to use a customer-managed key (the bring your own key, or "BYOK" scenario) as the Azure Information Protection tenant key. - -When you run this command, specify your own key vault name but you must specify the *ServicePrincipalName* parameter with the GUID **00000012-0000-0000-c000-000000000000** and specify the permissions in the example. - -## PARAMETERS - -### -ApplicationId -For future use. - -```yaml -Type: Guid -Parameter Sets: ByObjectId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BypassObjectIdValidation -Enables you to specify an object ID without validating that the object exists in Azure Active Directory. - -Use this parameter only if you want to grant access to your key vault to an object ID that refers to a delegated security group from another Azure tenant. - -```yaml -Type: SwitchParameter -Parameter Sets: ByObjectId -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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user email address of the user to whom to grant permissions. - -This email address must exist in the directory associated with the current subscription and be unique. - -```yaml -Type: String -Parameter Sets: ByEmailAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDeployment -Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this key vault is referenced in resource creation, for example when creating a virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForDiskEncryption -Enables the Azure disk encryption service to get secrets and unwrap keys from this key vault. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnabledForTemplateDeployment -Enables Azure Resource Manager to get secrets from this key vault when this key vault is referenced in a template deployment. - -```yaml -Type: SwitchParameter -Parameter Sets: ForVault -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -Specifies the object ID of the user or service principal in Azure Active Directory for which to grant permissions. - -```yaml -Type: String -Parameter Sets: ByObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionsToCertificates -Specifies an array of certificate permissions to grant to a user or service principal. - -The acceptable values for this parameter: - -- Get -- List -- Delete -- Create -- Import -- Update -- Managecontacts -- Getissuers -- Listissuers -- Setissuers -- Deleteissuers -- Manageissuers - -```yaml -Type: String[] -Parameter Sets: ByServicePrincipalName, ByUserPrincipalName, ByObjectId, ByEmailAddress -Aliases: -Accepted values: get, list, delete, create, import, update, managecontacts, getissuers, listissuers, setissuers, deleteissuers, manageissuers, recover, purge, all - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PermissionsToKeys -Specifies an array of key operation permissions to grant to a user or service principal. - -The acceptable values for this parameter: - -- Decrypt -- Encrypt -- UnwrapKey -- WrapKey -- Verify -- Sign -- Get -- List -- Update -- Create -- Import -- Delete -- Backup -- Restore -- Recover -- Purge - -```yaml -Type: String[] -Parameter Sets: ByServicePrincipalName, ByUserPrincipalName, ByObjectId, ByEmailAddress -Aliases: -Accepted values: decrypt, encrypt, unwrapKey, wrapKey, verify, sign, get, list, update, create, import, delete, backup, restore, recover, purge, all - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PermissionsToSecrets -Specifies an array of secret operation permissions to grant to a user or service principal. - -The acceptable values for this parameter: - -- Get -- List -- Set -- Delete -- Backup -- Restore -- Recover -- Purge - -```yaml -Type: String[] -Parameter Sets: ByServicePrincipalName, ByUserPrincipalName, ByObjectId, ByEmailAddress -Aliases: -Accepted values: get, list, set, delete, backup, restore, recover, purge, all - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PermissionsToStorage -Specifies managed storage account and SaS-definition operation permissions to grant to a user or service principal. - -```yaml -Type: String[] -Parameter Sets: ByServicePrincipalName, ByUserPrincipalName, ByObjectId, ByEmailAddress -Aliases: -Accepted values: get, list, delete, set, update, regeneratekey, getsas, listsas, deletesas, setsas, all - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -Specifies the service principal name of the application to which to grant permissions. - -Specify the application ID, also known as client ID, registered for the application in AzureActive Directory. The application with the service principal name that this parameter specifies must be registered in the Azure directory that contains your current subscription. - -```yaml -Type: String -Parameter Sets: ByServicePrincipalName -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -Specifies the user principal name of the user to whom to grant permissions. - -This user principal name must exist in the directory associated with the current subscription. - -```yaml -Type: String -Parameter Sets: ByUserPrincipalName -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -This cmdlet modifies the access policy for the key vault that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String, Guid, String[], Switch - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSVault - -## NOTES - -## RELATED LINKS - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) - -[Remove-AzureRmKeyVaultAccessPolicy](./Remove-AzureRmKeyVaultAccessPolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Stop-AzureKeyVaultCertificateOperation.md b/azurermps-2.5.0/AzureRm.Keyvault/Stop-AzureKeyVaultCertificateOperation.md deleted file mode 100644 index 90b6a999ab..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Stop-AzureKeyVaultCertificateOperation.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -ms.assetid: 3B042D79-658F-41F0-BD4D-9955F2E71CA1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/stop-azurekeyvaultcertificateoperation -schema: 2.0.0 ---- - -# Stop-AzureKeyVaultCertificateOperation - -## SYNOPSIS -Cancels a certificate operation in key vault. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureKeyVaultCertificateOperation [-VaultName] <String> [-Name] <String> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureKeyVaultCertificateOperation** cmdlet cancels a certificate operation in the Azure Key Vault service. - -## EXAMPLES - -### Example 1: Cancel a certificate operation -``` -PS C:\>Stop-AzureKeyVaultCertificateOperation -VaultName "Contoso01" -Name "TestCert02" -Force -Status : inProgress -CancellationRequested : True -CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCVr6EVwsd48qDVORsF4V4w4N1aQCUirFW7b+kwoTvSOL4SfMiWcPmno0uxmQQoh - gz157bC3sKFLyBUsGCmS4i7uWkBOSEpCh8L3FKU4XMqRROlUM9AqswzB0e1sURCqevEJA80xFpfTgkeqpm44m4jr6p7gu+h1PBf9Dt7b43Gybde5DUlGrrOiTkOIAF0eU2iNVeHOapoj8m1XHmzO1BARs - oa0pSDxO/aMgeuq/QPkWG64Iiw55U20byKZ86u3Y4g192HsPwsrHkf9ZSYR2M9BYM3YGoT/dkCmAtP4LQAsOwf1+S0a/TwRtrnoOHbPFI6HYSY3TY1iqzZ9xItfgalAgMBAAGgSzBJBgkqhkiG9w0BCQ4 - xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAjxUX5PGhri9qJTxSleGEbMVkxhhn3nuPUgxujEzrcQVr - fZAACJHbOnga/QYwpxumKWnkX9YdWxb58PPn+nLV2gYP3eYEyJ4DR9XDcKpoQxZahUdqD3JZXhWPIcN05tw9Fuq8ziw94BjLZW3h3iDamqkBnysJYW58FBp1H8Ejqk0Iynbo0V223Innq/7QB2fVwe3ZJ - JecT8YxHJjVQ5psdDpEWgLUG/DFiAPHdwupI7JjvtvQmT3AotL0x5GNx2bWNH5hHIXsX4bnbxZgNQnTB2w3tQ3QeuKt8fUx2S0xtxPllaCUul6efa84TNqdMcMfyxCarIwDP6qdhS+CDU1uUA== -ErrorCode : -ErrorMessage : -``` - -This command cancels the TestCert02 certificate operation. - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Specifies the name of a key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyVaultCertificateOperation - -## NOTES - -## RELATED LINKS - -[Get-AzureKeyVaultCertificateOperation](./Get-AzureKeyVaultCertificateOperation.md) - -[Remove-AzureKeyVaultCertificateOperation](./Remove-AzureKeyVaultCertificateOperation.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultCertificateRemoval.md b/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultCertificateRemoval.md deleted file mode 100644 index 70a8fce12e..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultCertificateRemoval.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultcertificateremoval -schema: 2.0.0 ---- - -# Undo-AzureKeyVaultCertificateRemoval - -## SYNOPSIS -Recovers a deleted certificate in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Undo-AzureKeyVaultCertificateRemoval [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultCertificateRemoval** cmdlet will recover a previously deleted certificate. -The recovered certificate will be active and can be used for all operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Undo-AzureKeyVaultCertificateRemoval -VaultName 'MyKeyVault' -Name 'MyCertificate' -``` - -This command will recover the certificate 'MyCertificate' that was previously deleted, into an active and usable state. - -## 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 -Certificate name. -Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment and certificate name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: CertificateName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.Certificate - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultCertificate](./Remove-AzureKeyVaultCertificate.md) - -[Get-AzureKeyVaultCertificate](./Get-AzureKeyVaultCertificate.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultKeyRemoval.md b/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultKeyRemoval.md deleted file mode 100644 index c8272251d0..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultKeyRemoval.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultkeyremoval -schema: 2.0.0 ---- - -# Undo-AzureKeyVaultKeyRemoval - -## SYNOPSIS -Recovers a deleted key in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Undo-AzureKeyVaultKeyRemoval [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultKeyRemoval** cmdlet will recover a previously deleted key. -The recovered key will be active and can be used for all normal key operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Undo-AzureKeyVaultKeyRemoval -VaultName 'MyKeyVault' -Name 'MyKey' -``` - -This command will recover the key 'MyKey' that was previously deleted, into an active and usable state. - -## 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 -Key name. -Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: KeyName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.KeyBundle - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultKey](./Remove-AzureKeyVaultKey.md) - -[Add-AzureKeyVaultKey](./Add-AzureKeyVaultKey.md) - -[Get-AzureKeyVaultKey](./Get-AzureKeyVaultKey.md) - diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultSecretRemoval.md b/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultSecretRemoval.md deleted file mode 100644 index c0e3e62993..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureKeyVaultSecretRemoval.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurekeyvaultsecretremoval -schema: 2.0.0 ---- - -# Undo-AzureKeyVaultSecretRemoval - -## SYNOPSIS -Recovers a deleted secret in a key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Undo-AzureKeyVaultSecretRemoval [-VaultName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureKeyVaultSecretRemoval** cmdlet will recover a previously deleted secret. -The recovered secret will be active and can be used for all normal secret operations. -Caller needs to have 'recover' permission in order to perform this operation. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Undo-AzureKeyVaultSecretRemoval -VaultName 'MyKeyVault' -Name 'MySecret' -``` - -This command will recover the secret 'MySecret' that was previously deleted, into an active and usable state. - -## 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 -Secret name. -Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SecretName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.Secret - -## NOTES - -## RELATED LINKS - -[Remove-AzureKeyVaultSecret](./Remove-AzureKeyVaultSecret.md) - - - -[Get-AzureKeyVaultSecret](./Get-AzureKeyVaultSecret.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureRmKeyVaultRemoval.md b/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureRmKeyVaultRemoval.md deleted file mode 100644 index 4aa704fd36..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Undo-AzureRmKeyVaultRemoval.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/undo-azurermkeyvaultremoval -schema: 2.0.0 ---- - -# Undo-AzureRmKeyVaultRemoval - -## SYNOPSIS -Recovers a deleted key vault into an active state. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Undo-AzureRmKeyVaultRemoval [-VaultName] <String> [-ResourceGroupName] <String> [-Location] <String> - [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Undo-AzureRmKeyVaultRemoval** cmdlet will recover a previously deleted key vault. The -recovered vault will be active after recovery - -## EXAMPLES - -### Example 1 -``` -PS C:\> Undo-AzureRmKeyVaultRemoval -VaultName 'MyKeyVault' -ResourceGroupName 'MyResourceGroup' -Location 'eastus2' -Tag @{"x"= "y"} -``` - -This command will recover the key vault 'MyKeyVault' that was previously deleted from eastus2 -region and 'MyResourceGroup' resource group, into an active and usable state. It also replaces the -tags with new tag. - -## 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 deleted vault original Azure region. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of an existing resource group in which to create the key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.PSVault - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmKeyVault](./Remove-AzureRmKeyVault.md) - -[New-AzureRmKeyVault](./New-AzureRmKeyVault.md) - -[Get-AzureRmKeyVault](./Get-AzureRmKeyVault.md) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccount.md b/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccount.md deleted file mode 100644 index 9be342df03..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccount.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultmanagedstorageaccount -schema: 2.0.0 ---- - -# Update-AzureKeyVaultManagedStorageAccount - -## SYNOPSIS -Update editable attributes of a Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> - [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>] [-RegenerationPeriod <TimeSpan>] [-Enable <Boolean>] - [-Tag <Hashtable>] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Update the editable attributes of a Key Vault managed Azure Storage Account. - -## EXAMPLES - -### Example 1:Update the active key to 'key2' on a Key Vault managed Azure Storage Account. -``` -PS C:\> Update-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -ActiveKeyName 'key2' -``` - -Updates the Key Vault managed Azure Storage Account active key to 'key2'. 'key2' will be used to -generate SAS tokens after this update. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account -name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ActiveKeyName -Active key name. -If not specified, the existing value of managed storage account's active key name remains unchanged - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutoRegenerateKey -Auto regenerate key. -If not specified, the existing value of auto regenerate key of managed storage account remains unchanged - -```yaml -Type: Boolean -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 - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -If present, enables a use of a managed storage account key for sas token generation if value is -true. Disables use of a managed storage account key for sas token generation if value is false. If -not specified, the existing value of the storage account's enabled/disabled state remains -unchanged. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return object by default. If this switch is specified, return managed storage -account object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegenerationPeriod -Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after -which managed storage account's inactive keygets auto regenerated and becomes the active key. If -not specified, the existing value of regeneration period of keys of managed storage account remains -unchanged - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[AzureRM.KeyVault](/powershell/module/azurerm.keyvault) diff --git a/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccountKey.md b/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccountKey.md deleted file mode 100644 index 63b78750a0..0000000000 --- a/azurermps-2.5.0/AzureRm.Keyvault/Update-AzureKeyVaultManagedStorageAccountKey.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml -Module Name: AzureRM.KeyVault -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.keyvault/update-azurekeyvaultmanagedstorageaccountkey -schema: 2.0.0 ---- - -# Update-AzureKeyVaultManagedStorageAccountKey - -## SYNOPSIS -Regenerates the specified key of Key Vault managed Azure Storage Account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureKeyVaultManagedStorageAccountKey [-VaultName] <String> [-AccountName] <String> [-KeyName] <String> - [-Force] [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Regenerates the specified key of Key Vault managed Azure Storage Account and sets the key as the active key. Key Vault proxies the call to Azure Resource Manager to regenerate the key. The caller must posses permissions to regenerate keys on given Azure Storage Account. - -## EXAMPLES - -### Example 1: Regenerate a key -``` -PS C:\> Update-AzureKeyVaultManagedStorageAccountKey -VaultName 'myvault' -AccountName 'mystorageaccount' -KeyName 'key1' -``` - -Regenerates 'key1' of account 'mystorageaccount' and sets 'key1' as the active of the Key Vault managed Azure Storage Account. - -## PARAMETERS - -### -AccountName -Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and manged storage account name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageAccountName, Name - -Required: True -Position: 1 -Default value: None -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 -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Name of storage account key to regenerate and make active. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Cmdlet does not return an object by default. -If this switch is specified, cmdlet returns the managed storage account that was deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VaultName -Vault name. -Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.KeyVault.Models.ManagedStorageAccount - -## NOTES - -## RELATED LINKS - -[Azure Key Vault cmdlets](/powershell/module/azurerm.keyvault/) diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 16c1eb2262..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 38855E74-F30C-43DF-8D94-ABD7872BCE11 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Adds an authentication certificate to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> - -Name <String> -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet adds an authentication certificate to an Azure application gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet adds an authentication certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the authentication certificate that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 a certificate that this cmdlet adds to the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index 6f6a7ea93c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6FBFAEFF-786D-440A-94B2-8C27BE033A0A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Adds a back-end address pool to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayBackendAddressPool** cmdlet adds a back-end address pool to an application gateway. -A back-end address can be specified using an IP address, a fully-qualified domain name (FQDN) or IP configuration IDs. - -## EXAMPLES - -### Example 1: Add a back-end address pool by using a back-end server FQDN -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", " contoso1.com" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using FQDNs. - -### Example 2: Add a back-end address pool by using backend server IP addresses -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add -AzureApplicationGatewayBackendAddressPool -ApplicationGateway $ AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command adds the back-end address pool of the application gateway stored in $AppGw by using IP addresses. - -### Example 3: Seta back-end address pool by using the ID of the backend server's IP address -``` -PS C:\>$Nic01 = Get-AzureRmNetworkInterface -Name "Nic01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Nic02 = Get-AzureRmNetworkInterface -Name "Nic02" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $ AppGw -Name "Pool02" -BackendIPConfigurationIds $nic01.Properties.IpConfigurations[0].Id, $nic02.Properties.IpConfiguration[0].Id -``` - -The first command gets a network interface object named Nic01 that belongs to the resource group named ResourceGroup01, and stores it in the $Nic01 variable.The second command gets a network interface object named Nic02 that belongs to the resource group named ResourceGroup02, and stores it in the $Nic02 variable.The third command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The forth command uses the back-end IP configuration IDs from $Nic01 and $Nic02 to add the back-end address pool of the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a back-end address pool. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendFqdns -Specifies a list of backend FQDNs which this cmdlet adds as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -Specifies a list of back-end IP addresses which this cmdlet adds as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 back-end server pool that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index 62f0f9027b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Adds back-end HTTP settings to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-ProbeEnabled] - [-Path <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmApplicationGatewayBackendHttpSettings cmdlet adds back-end HTTP settings to an application gateway. - -Back-end HTTP settings are applied to all back-end servers in the pool. - -## EXAMPLES - -### Example 1: Add back-end HTTP settings to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "HTTP" -CookieBasedAffinity "Disabled" -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable.The second command adds back-end HTTP settings to the application gateway, setting the port to 88 and the protocol to HTTP and names the settings Setting02. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet adds settings. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. -The acceptable values for this parameter are: Disabled, Enabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings which this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port of the back-end server pool. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a back-end server. - -```yaml -Type: PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeEnabled -Flag if probe should be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol for communication between application gateway and back-end servers. -The acceptable values for this parameter are: Http and Https. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies the request time-out value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index 5aa81a2e8a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0ECE4232-EA5D-46A0-8260-69646E27FA9A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Adds a front-end IP configuration to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayFrontendIPConfig** cmdlet adds a front-end IP configuration to an application gateway. -An application gateway supports two types of front-end IP configurations: - -- Public IP addresses -- Private IP addresses using internal load-balancing (ILB) - -An application gateway can have at most one public IP and one private IP. -Add the public IP address and private IP address as separate front-end IPs. - -## EXAMPLES - -### Example 1: Add a public IP as the front-end IP address -``` -PS C:\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp -``` - -The first command creates a public IP address object and stores it in the $PublicIp variable. -The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The third command adds the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. - -### Example 2: Add a static private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. - -### Example 3: Add a dynamic private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a front-end IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end IP configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address to add as a front-end IP for the application gateway. -If specified, this IP is statically allocated from the subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address which this cmdlet adds as a front-end IP address for the application gateway. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the ID of the public IP address which this cmdlet adds as a front-end IP address for the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet which this cmdlet adds as front-end IP configuration. -If you specify this parameter, it implies that the application gateway supports a private IP based-configuration. -If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID which this cmdlet adds as the front-end IP configuration. -Passing subnet implies private IP. -If the *PrivateIPAddresss* parameter is specified, it should belong to this subnet. -Otherwise, one of the IP from this subnet is dynamically picked up as the front-end IP of the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendPort.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 9b177fa0e9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 40198C86-A4EB-494A-86D5-DF632518EB95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayfrontendport -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Adds a front-end port to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayFrontendPort** cmdlet adds a front-end port to an application gateway. - -## EXAMPLES - -### Example 1: Add a front-end port to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $ AppGw = Add-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command adds port 80 as a front-end port for the application gateway stored in $AppGw and names the port FrontEndPort01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a front-end port. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end port. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayHttpListener.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index 6d27df6c64..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1E192553-61D8-4449-936B-68CF866C710C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayhttplistener -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Adds an HTTP listener to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayHttpListener** cmdlet adds a HTTP listener to an application gateway. - -## EXAMPLES - -### Example 1: Add a HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Appgw = Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "listener01" -Protocol "Http" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable.The second command adds the HTTP listener to the application gateway. - -### Example 2: Add a HTTPS listener with SSL -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIP01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the listener, which uses the HTTPS protocol, to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds an HTTP listener. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -FrontendIPConfiguration -Specifies the application gateway front-end IP resource object. - -```yaml -Type: PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the application gateway front-end IP ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the application gateway front-end port object. - -```yaml -Type: PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the application gateway front-end port ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet adds a HTTP listener to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end port that this command adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol of the HTTP listener. -Both HTTP and HTTPS are supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate of the HTTP listener. -Must be specified if HTTPS is chosen as listener protocol. - -```yaml -Type: PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the SSL certificate ID of the HTTP listener. -Must be specified if HTTPS is chosen as listener protocol. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 46fda2c208..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5358C08F-A1EB-457E-85B1-7F12396A873A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayipconfiguration -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Adds an IP configuration to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayIPConfiguration** cmdlet adds an IP configuration to an application gateway. -IP configurations contain the subnet in which the application gateway is deployed. - -## EXAMPLES - -### Example 1: Add an virtual network configuration to an application gateway -``` -PS C:\>$Vnet = Get-AzureRmVirtualNetwork -Name "Vnet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $Vnet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Add-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Appgwsubnet01" -Subnet $Subnet -``` - -The first command creates a virtual network. -The second command creates a subnet using the previously created virtual network. -The third command gets the application gateway and stores it in the $AppGw variable. -The fouth command adds the IP configuration to the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds an IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the IP configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a subnet. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies a subnet ID. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 97087a6208..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayprobeconfig -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Adds a health probe to an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -Protocol <String> [-HostName <String>] -Path <String> -Interval <Int32> -Timeout <Int32> - -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] - [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmApplicationGatewayProbeConfig cmdlet adds a health probe to an Application Gateway. - -## EXAMPLES - -### Example 1: Add a health probe to an application gateway -``` -PS C:\>$Probe = Add-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe01" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command adds a health probe named Probe01 for the application gateway named Gateway. -The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a probe. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid path start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. -This cmdlet supports HTTP only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 78f5c5ef27..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Adds a redirect configuration to an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] - [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayRedirectConfiguration** cmdlet adds a redirect configuration to an Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\>$Appgw = Add-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the redirect configuration to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: String -Parameter Sets: SetByURL -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 0d049cf136..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BBA600C2-4813-4C12-8447-E770A949DA32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Adds a request routing rule to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] - [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayRequestRoutingRule** cmdlet adds a request routing rule to an application gateway. - -## EXAMPLES - -### Example 1: Add a request routing rule to an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Appgw = Add-AzureApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -The first command gets the application gateway and stores it in the $AppGw variable. -The second command adds the request routing rule to the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway to which this cmdlet adds a request routing rule. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies an application gateway back-end address pool object. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies an application gateway back-end address pool ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies a back-end HTTP settings object for an application gateway. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies a backend HTTP settings ID for an application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies application gateway HTTP listener object. - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies application gateway HTTP listener ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of request routing rule this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies the type of request routing rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -Specifies the URL path map ID for the routing rule. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewaySslCertificate.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 21d42d7f56..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7EC4C642-1D23-4699-AE00-6E180C38271E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewaysslcertificate -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Adds an SSL certificate to an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> -Password <SecureString> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewaySslCertificate** cmdlet adds an SSL certificate to an application gateway. - -## EXAMPLES - -### Example 1: Add an SSL certificate to an application gateway. -``` -PS C:\> $AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $AppGW = Add-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command gets an application gateway named ApplicationGateway01 and then adds an SSL certificate named Cert01 to it. - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway to which this cmdlet adds an SSL certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the .pfx file of an SSL certificate that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 SSL certificate that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL certificate that this cmdlet adds. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index caab462661..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9D9D079C-5557-40DC-8CFB-1DCD446D9109 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 ---- - -# Add-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Adds an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet adds an array of URL path mappings to a back end server pool. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet adds a URL path map configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name that this cmdlet adds to the backend server pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -The path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index 984428741b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9994E2B2-20A1-4E95-9A9F-379B8B63F7F5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermexpressroutecircuitauthorization -schema: 2.0.0 ---- - -# Add-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Adds an ExpressRoute circuit authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmExpressRouteCircuitAuthorization -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet adds an authorization to an ExpressRoute -circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a -connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can -create as many as 10 authorizations for each circuit; these authorizations generate an -authorization key that can be used by a virtual network owner to connect his or her network to the -circuit (one authorization per virtual network). **Add-AzureRmExpressRouteCircuitAuthorization** -adds a new authorization to a circuit and, at the same time, generates the corresponding -authorization key. These keys can be viewed at any time by running the -Get-AzureRmExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded -to the appropriate network owner. - -Note that, after running **Add-AzureRmExpressRouteCircuitAuthorization**, you must call the -Set-AzureRmExpressRouteCircuit cmdlet to activate the key. If you do not call -**Set-AzureRmExpressRouteCircuit** the authorization will be added to the circuit but will not be -enabled for use. - -## EXAMPLES - -### Example 1: Add an authorization to the specified ExpressRoute circuit -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Add-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit -``` - -The commands in this example add a new authorization to an existing ExpressRoute circuit. The first -command uses **Get-AzureRmExpressRouteCircuit** to create an object reference to a circuit named -ContosoCircuit. That object reference is stored in a variable named $Circuit. - -In the second command, the **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet is used to add a -new authorization (ContosoCircuitAuthorization) to the ExpressRoute circuit. This command adds the -authorization but does not activate that authorization. Activating an authorization requires the -**Set-AzureRmExpressRouteCircuit** shown in the final command in the example. - -## 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 -``` - -### -ExpressRouteCircuit -Specifies the ExpressRoute circuit that this cmdlet adds the authorization to. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the circuit authorization to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -**Add-AzureRmExpressRouteCircuitAuthorization** accepts pipelined instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object. - -## OUTPUTS - -### PSExpressRouteCircuit -**Add-AzureRmExpressRouteCircuitAuthorization** modifies instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index 35db1efe86..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C44AD23A-E575-418C-BE90-323B44D6D2E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 ---- - -# Add-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Adds a peering configuration to an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -Add-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an -ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud -by using a connectivity provider instead of the public Internet. Note that, after running -**Add-AzureRmExpressRouteCircuitPeeringConfig**, you must call the Set-AzureRmExpressRouteCircuit -cmdlet to activate the configuration. - -## EXAMPLES - -### Example 1: Add a peer to an existing ExpressRoute circuit -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 200 -} -Add-AzureRmExpressRouteCircuitPeeringConfig @parameters -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## 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 -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit being modified. This is Azure object returned by the -**Get-AzureRmExpressRouteCircuit** cmdlet. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering relationship to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 6ae242aaeb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9EB11283-0189-4333-8142-DCC3F770F91A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Adds a backend address pool configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLoadBalancerBackendAddressPoolConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerBackend** cmdlet adds a backend address pool to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a backend address pool configuration to a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "myrg" | Add-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named MyLoadBalancer, adds the backend address pool named BackendAddressPool02 to MyLoadBalancer, and then uses the **Set-AzureRmLoadBalancer** cmdlet to update MyLoadBalancer. - -## 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 -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the backend address pool configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 92ce6b5159..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 07FF274A-F365-44E5-A66B-6740CD165664 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerfrontendipconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Adds a front-end IP configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet -``` -Add-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-PrivateIpAddress <String>] -Subnet <PSSubnet> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -Add-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-PrivateIpAddress <String>] -SubnetId <String> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -Add-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - -PublicIpAddressId <String> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -Add-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - -PublicIpAddress <PSPublicIpAddress> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerFrontendIpConifg** cmdlet adds a front-end IP configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a front-end IP configuration with a dynamic IP address -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyRg" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. -The command then stores the result in the variable named $Subnet. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a dynamic private IP address from the subnet stored in the variable named $MySubnet. - -### Example 2 Add a front-end IP configuration with a static IP address -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "RG001" | Get-AzureRmVirtualNetworkSubnetConfig -Name "MySubnet" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -Subnet $Subnet -PrivateIpAddress "10.0.1.6" | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure virtual network named MyVnet and passes the result using the pipeline to the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet to get the subnet named MySubnet. -The command then stores the result in the variable named $Subnet. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with a static private IP address from the subnet stored in the variable named $Subnet. - -### Example 3 Add a front-end IP configuration with a public IP address -``` -PS C:\>$PublicIp = Get-AzureRmPublicIpAddress -ResourceGroupName "myRG" -Name "MyPub" -PS C:\> Get-AzureRmLoadBalancer -Name "MyLB" -ResourceGroupName "NrpTest" | Add-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendName" -PublicIpAddress $PublicIp | Set-AzureRmLoadBalancer -``` - -The first command gets the Azure public IP address named MyPub and stores the result in the variable named $PublicIp. -The second command gets the load balancer named MyLB and passes the result to the **Add-AzureRmLoadBalancerFrontendIpConfig** cmdlet that adds a front-end IP configuration to the load balancer with public IP address stored in the variable named $PublicIp. - -## 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 -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a front-end IP configuration to the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address to associate with a front-end IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the public IP address to associate with a front-end IP configuration. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifes the ID of the public IP address in which to add a front-end IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object in which to add a front-end IP configuration. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet in which to add a front-end IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index de7206ff3c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EB4DF001-AD05-4747-972B-5E4194A404C8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index f5eeecc187..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EE8F5D57-1ECE-4F23-9A5B-F226DD2C5ECB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Adds an inbound NAT rule configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet adds an inbound network address translation (NAT) rule configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1: Add an inbound NAT rule configuration to a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -``` - -The first command gets the load balancer named MyloadBalancer, and then stores it in the variable $slb. - -The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzureRmLoadBalancerInboundNatRuleConfig**, which adds an inbound NAT rule configuration to the load balancer. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic matched by a rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies an ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds an inbound NAT rule configuration to the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by an inbound NAT rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 0e6c7f4c8a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6F9BAB0B-7DC7-4672-B2B5-8B139D652DDD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerprobeconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Adds a probe configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmLoadBalancerProbeConfig -Name <String> -LoadBalancer <PSLoadBalancer> [-RequestPath <String>] - [-Protocol <String>] -Port <Int32> -IntervalInSeconds <Int32> -ProbeCount <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerProbeConfig** cmdlet adds a probe configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1 Add a probe configuration to a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "myLb" -ResourceGroupName "myRg" | Add-AzureRmLoadBalancerProbeConfig -Name "probeName" -RequestPath healthcheck2.aspx -Protocol http -Port 81 -IntervalInSeconds 16 -ProbeCount 3 | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named myLb, adds the specified probe configuration to it, and then uses the **Set-AzureRmLoadBalancer** cmdlet to update the load balancer. - -## 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 -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of the load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a probe configuration to the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which probes should connect to a load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probe. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Http - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in the load-balanced service to probe to determine health. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index 8df23f91a9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2AE5E9B8-7344-407B-9317-47709F10FCD8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermloadbalancerruleconfig -schema: 2.0.0 ---- - -# Add-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Adds a rule configuration to a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmLoadBalancerRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] [-BackendAddressPoolId <String>] [-ProbeId <String>] - [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-LoadDistribution <String>] [-EnableFloatingIP] [-DisableOutboundSNAT] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmLoadBalancerRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool>] - [-Probe <PSProbe>] [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] - [-IdleTimeoutInMinutes <Int32>] [-LoadDistribution <String>] [-EnableFloatingIP] [-DisableOutboundSNAT] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmLoadBalancerRuleConfig** cmdlet adds a rule configuration to an Azure load balancer. - -## EXAMPLES - -### Example 1: Add a rule configuration to a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. - -The second command uses the pipeline operator to pass the load balancer in $slb to **Add-AzureRmLoadBalancerRuleConfig**, which adds the rule configuration named NewRule. - -## PARAMETERS - -### -BackendAddressPool -Specifies the backend address pool to associate with a load balancer rule configuration. - -```yaml -Type: PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in the load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a **LoadBalancer** object. -This cmdlet adds a rule configuration to the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Default, SourceIP, SourceIPProtocol - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specfies the protocol that is matched by a load balancer rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, All - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkInterfaceIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 342b2fa2aa..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7610228A-61F9-41B8-A42A-CD7C793BB33F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermnetworkinterfaceipconfig -schema: 2.0.0 ---- - -# Add-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Adds a network interface IP configuration to a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] - [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmNetworkInterfaceIpConfig** cmdlet adds a network interface IP configuration to an Azure network interface. - -## EXAMPLES - -### Example 1: Add a new IP configuration with an application security group -``` -$subnet = New-AzureRmVirtualNetworkSubnetConfig -Name MySubnet -AddressPrefix 10.0.1.0/24 -$vnet = New-AzureRmvirtualNetwork -Name MyVNET -ResourceGroupName MyResourceGroup -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $subnet - -$nic = New-AzureRmNetworkInterface -Name MyNetworkInterface -ResourceGroupName MyResourceGroup -Location "West US" -Subnet $vnet.Subnets[0] - -$asg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyASG -Location "West US" - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name $nic.IpConfigurations[0].Name -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzureRmNetworkInterface - -$nic | Add-AzureRmNetworkInterfaceIpConfig -Name MyNewIpConfig -Subnet $vnet.Subnets[0] -ApplicationSecurityGroup $asg | Set-AzureRmNetworkInterface -``` - -In this example, we create a new network interface MyNetworkInterface that belongs to a subnet in the new virtual network MyVNET. We also create an empty application security group MyASG to associate with the IP configurations in the network interface. Once both objects are created, we link the default IP configuration to the MyASG object. At last, we create a new IP configuration in the network interface also linked to the application security group object. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This cmdlet adds a network interface IP configuration to the object that this parameter specifies. - -```yaml -Type: PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. -The acceptable values for this parameter are: - -- IPv4 -- IPv6 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkInterface -Parameter 'NetworkInterface' accepts value of type 'PSNetworkInterface' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkSecurityRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index cdc169d64b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9160A21D-0F83-415B-830B-F35C8B863E90 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermnetworksecurityruleconfig -schema: 2.0.0 ---- - -# Add-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Adds a network security rule configuration to a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmNetworkSecurityRuleConfig** cmdlet adds a network security rule configuration to an Azure network security group. - -## EXAMPLES - -### 1: Adding a network security group -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | -Add-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access - Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet - -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 | - Set-AzureRmNetworkSecurityGroup -``` - -The first command retrieves an Azure network security group named "nsg1" from resource group "rg1". The second command adds a network security rule named "rdp-rule" that allows traffic from internet on port 3389 to the retrieved network security group object. Persists the modified Azure network security group. - -### 1: Adding a new security rule with application security groups -``` -$srcAsg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name srcAsg -Location "West US" -$destAsg = New-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name destAsg -Location "West US" - -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 | -Add-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access - Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceApplicationSecurityGroup - $srcAsg -SourcePortRange * -DestinationApplicationSecurityGroup $destAsg -DestinationPortRange 3389 | -Set-AzureRmNetworkSecurityGroup -``` - -First, we create two new application security groups. Then, we retrieve an Azure network security group named "nsg1" from resource group "rg1". and add a network security rule named "rdp-rule" to it. The rule allows traffic from all the IP configurations in the application security group "srcAsg" to all the IP configurations in "destAsg" on port 3389. After adding the rule, we persist the modified Azure network security group. - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of a network security rule configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: - -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address - -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: - -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated on incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a network security rule configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This cmdlet adds a network security rule configuration to the object that this parameter specifies. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are: An integer between 100 and 4096. - -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a rule configuration applies to. -The acceptable values for this parameter are: - -- Tcp -- Udp -- Wildcard character (*) to match both - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: - -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address. - -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies a source port or range. -This value is expressed as an integer, as a range between 0 and 65535, or as a wildcard character (*) to match any source port. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkSecurityGroup -Parameter 'NetworkSecurityGroup' accepts value of type 'PSNetworkSecurityGroup' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteConfig.md deleted file mode 100644 index df51010e21..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteConfig.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C868DFA4-8A9D-4108-B88B-ACD7F100A63C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermrouteconfig -schema: 2.0.0 ---- - -# Add-AzureRmRouteConfig - -## SYNOPSIS -Adds a route to a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmRouteConfig -RouteTable <PSRouteTable> [-AddressPrefix <String>] [-NextHopType <String>] - [-NextHopIpAddress <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmRouteConfig** cmdlet adds a route to an Azure route table. - -## EXAMPLES - -### Example 1: Add a route to a route table -``` -PS C:\>$RouteTable = Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" -PS C:\> Add-AzureRmRouteConfig -Name "Route13" -AddressPrefix 10.3.0.0/16 -NextHopType "VnetLocal" -RouteTable $RouteTable -``` - -The first command gets a route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. -The command stores the table in the $RouteTable variable. - -The second command adds a route named Route13 to the route table stored in $RouteTable. -This route forwards packets to the local virtual network. - -### Example 2: Add a route to a route table by using the pipeline -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzureRmRouteConfig -Name "Route02" -AddressPrefix 10.2.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/routetable01 -Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route02", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route02", - "AddressPrefix": "10.2.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route13", - "Etag": null, - "Id": null, - "AddressPrefix": "10.3.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": null - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using **Get-AzureRmRouteTable**. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet adds the route named Route02, and then passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```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. - -```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 a name of the route to add to the route table. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azure virtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: - -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azure server-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table to which this cmdlet adds a route. - -```yaml -Type: PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteTable -Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteFilterRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 152e65e440..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermroutefilterruleconfig -schema: 2.0.0 ---- - -# Add-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -Adds a route filter rule to a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> - -RouteFilterRuleType <String> -CommunityList <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Add-AzureRmRouteFilterRuleConfig cmdlet adds a route filter rule to an Azure route filter. - -## EXAMPLES - -### -------------------------- Example 1: Add a route filter rule to a route filter -------------------------- -``` -PS C:\>$RouteFilter = Get-AzureRmRouteFilter -ResourceGroupName "ResourceGroup11" -Name "routefilter01" - PS C:\> Add-AzureRmRouteFilterRuleConfig -Name "rule13" -Access Allow -RouteFilterRuleType Community -RouteFilter $RouteFilter -``` - -The first command gets a route filter named routefilter01 by using the Get-AzureRmRouteFilter cmdlet. -The command stores the filter in the $RouteFilter variable. - -## PARAMETERS - -### -Access -Specifies the access of the route filter rule, Valid values are Deny or Allow. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the route filter rule to add to the route filter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -Specifies the route filter to which this cmdlet adds a route filter rule. - -```yaml -Type: PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -Specifies the route filter rule type. -Valid values are: Community - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteFilter -Parameter 'RouteFilter' accepts value of type 'PSRouteFilter' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmRouteFilterRuleConfig](./Get-AzureRmRouteFilterRuleConfig.md) - -[Get-AzureRmRouteFilter](./Get-AzureRmRouteFilter.md) - - - - - - - -[Set-AzureRmRouteFilter](./Set-AzureRmRouteFilter.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index 93ff545367..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BCB64535-FF37-46EF-85AF-7286BB67787B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 ---- - -# Add-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS -Adds an IP configuration to a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-PrivateIpAddress <String>] [-SubnetId <String>] [-PublicIpAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResource -``` -Add-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkGatewayIpConfig** cmdlet adds an IP configuration to a virtual network gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -Specifies the name of the gateway IP configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the public IP address. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the public IP address. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **PSSubnet** object. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies a **PSVirtualNetworkGateway** object. -This cmdlet modifies the **PSVirtualNetworkGateway** object that you specify. -You can use the Get-AzureRmVirtualNetworkGateway cmdlet to retrieve a **PSVirtualNetworkGateway** object. - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetworkGateway -Parameter 'VirtualNetworkGateway' accepts value of type 'PSVirtualNetworkGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGatewayIpConfig](./New-AzureRmVirtualNetworkGatewayIpConfig.md) - -[Remove-AzureRmVirtualNetworkGatewayIpConfig](./Remove-AzureRmVirtualNetworkGatewayIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkPeering.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index b674a94541..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 13901193-8C68-4969-ADCD-2E82EA714354 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworkpeering -schema: 2.0.0 ---- - -# Add-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Creates a peering between two virtual networks. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVirtualNetworkPeering -Name <String> -VirtualNetwork <PSVirtualNetwork> - -RemoteVirtualNetworkId <String> [-BlockVirtualNetworkAccess] [-AllowForwardedTraffic] [-AllowGatewayTransit] - [-UseRemoteGateways] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkPeering** cmdlet creates a peering between two virtual networks. - -## EXAMPLES - -### Example 1: Create a peering between two virtual networks in the same region -``` -# Variables for common values used throughout the script. -$rgName='myResourceGroup' -$location='eastus' - -# Create a resource group. -New-AzureRmResourceGroup -Name $rgName -Location $location - -# Create virtual network 1. -$vnet1 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location $location - -# Create virtual network 2. -$vnet2 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location $location - -# Peer VNet1 to VNet2. -Add-AzureRmVirtualNetworkPeering -Name myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id - -# Peer VNet2 to VNet1. -Add-AzureRmVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id -``` - -Note that a peering link must be created from vnet1 to vnet2 and vice versa in order for peering to work. - -### Example 2: Create a peering between two virtual networks in different regions -``` -# Variables for common values used throughout the script. -$rgName='myResourceGroup' - -# Create a resource group. -New-AzureRmResourceGroup -Name $rgName -Location westcentralus - -# Create virtual network 1. -$vnet1 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet1' -AddressPrefix '10.0.0.0/16' -Location westcentralus - -# Create virtual network 2. -$vnet2 = New-AzureRmVirtualNetwork -ResourceGroupName $rgName -Name 'myVnet2' -AddressPrefix '10.1.0.0/16' -Location candacentral - -# Peer VNet1 to VNet2. -Add-AzureRmVirtualNetworkPeering -Name myVnet1ToMyVnet2' -VirtualNetwork $vnet1 -RemoteVirtualNetworkId $vnet2.Id - -# Peer VNet2 to VNet1. -Add-AzureRmVirtualNetworkPeering -Name 'myVnet2ToMyVnet1' -VirtualNetwork $vnet2 -RemoteVirtualNetworkId $vnet1.Id -``` - -Here 'myVnet1' in US West Central is peered with 'myVnet2' in Canada Central. - -## PARAMETERS - -### -AllowForwardedTraffic -Indicates that this cmdlet allows the forwarded traffic from the virtual machines in the remote virtual network. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowGatewayTransit -Flag to allow gatewayLinks be used in remote virtual network's link to this virtual network - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: AlloowGatewayTransit - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockVirtualNetworkAccess -Indicates that this cmdlet blocks the virtual machines in the linked virtual network space to access all the virtual machines in local virtual network space. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 virtual network peering. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteVirtualNetworkId -Specifies the ID of the remote virtual network. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UseRemoteGateways -Indicates that this cmdlet allows remote gateways on this virtual network. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the parent virtual network. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -Parameter 'RemoteVirtualNetworkId' accepts value of type 'String' from the pipeline - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetworkPeering](./Get-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - -[Set-AzureRmVirtualNetworkPeering](./Set-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index a978a3e7d2..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B8B632B5-9D3B-4352-B4C8-49C00472B3A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvirtualnetworksubnetconfig -schema: 2.0.0 ---- - -# Add-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Adds a subnet configuration to a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Add-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Add-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String> - [-NetworkSecurityGroupId <String>] [-RouteTableId <String>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVirtualNetworkSubnetConfig** cmdlet adds a subnet configuration to an existing Azure virtual network. - -## EXAMPLES - -### 1: Add a subnet to an existing virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - $virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - Add-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.2.0/24" - $virtualNetwork | Set-AzureRmVirtualNetwork -``` - - This example first creates a resource group as a container of the resources to be created. It then creates a subnet configuration and uses it to create a virtual network. The - Add-AzureRmVirtualNetworkSubnetConfig is then used to add a subnet to the in-memory representation of the virtual network. The Set-AzureRmVirtualNetwork command updates the existing virtual - network with the new subnet. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 subnet configuration to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This cmdlet adds a virtual network subnet configuration to the object that this parameter specifies. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -```yaml -Type: PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object in which to add a subnet configuration. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRevokedCertificate.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index 6f43eb2882..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 90FB7B88-844E-4783-A10F-04D7BA47C030 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvpnclientrevokedcertificate -schema: 2.0.0 ---- - -# Add-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Adds a VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVpnClientRevokedCertificate** cmdlet assigns a client-revocation certificate to a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -You need to specify both the certificate name and the certificate thumbprint to use this cmdlet. - -## EXAMPLES - -### Example 1: Add a new client-revocation certificate to a virtual network gateway -``` -PS C:\>Add-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command adds a new client-revocation certificate to the virtual network gateway named ContosoVirtualNetwork. -In order to add the certificate, you must specify both the certificate name and the certificate thumbprint. - -## 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 the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being added. -For example: - --Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" - -You can get thumbprint information for your certificates by using a Windows PowerShell command similar to this: `Get-ChildItem -Path Cert:\LocalMachine\Root`. - -The preceding command gets information for all the local computer certificates found in the root certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the certificate should be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRootCertificate.md b/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index 8ae590ba5c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Add-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B9153CA9-06D1-4EF3-9863-D649C2EBAEAA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/add-azurermvpnclientrootcertificate -schema: 2.0.0 ---- - -# Add-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Adds a VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Add-AzureRmVpnClientRootCertificate -VpnClientRootCertificateName <String> -VirtualNetworkGatewayName <String> - -ResourceGroupName <String> -PublicCertData <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmVpnClientRootCertificate** cmdlet adds a root certificate to a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority. -By design, all certificates used on the gateway trust the root certificate. - -This cmdlet assigns an existing certificate as a gateway root certificate. -If you do not have an X.509 certificate available you can generate one through your public key infrastructure or use a certificate generator such as makecert.exe. - -To add a root certificate, you must specify the certificate name and provide a text-only representation of the certificate (see *the PublicCertData* parameter for more information). -Azure allows you to assign more than one root certificate to a gateway. -Multiple root certificates are often deployed by organizations that include users from more than one company. - -## EXAMPLES - -### Example 1: Add a client root certificate to a virtual gateway -``` -PS C:\>$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> Add-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway" -VpnClientRootCertificateName "ContosoClientRootCertificate" -``` - -This example adds a client root certificate to a virtual gateway named ContosoVirtualGateway. - -The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the root certificate and stores that text data the variable named $Text. - -The second command then uses a for loop to extract all the text except for the first line and the last line. -The extracted text is stored in a variable named $CertificateText. - -The third command then uses the text stored in $CertificateText with the **Add-AzureRmVpnClientRootCertificate** cmdlet to add the root certificate to the gateway. - -## 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 -``` - -### -PublicCertData -Specifies the text representation of the root certificate to be added. -To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. -When you do that, you will see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): - ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- - -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve this data by using Windows PowerShell commands similar to this: `$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer"` -`$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]}` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the root certificate is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the certificate is added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet adds. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/AzureRM.Network.md b/azurermps-2.5.0/AzureRm.Network/AzureRM.Network.md deleted file mode 100644 index c28b2cb464..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/AzureRM.Network.md +++ /dev/null @@ -1,799 +0,0 @@ ---- -Module Name: AzureRM.Network -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -Download Help Link: {{Please enter FwLink manually}} -Help Version: {{Please enter version of help manually (X.X.X.X) format}} -Locale: en-US ---- - -# AzureRM.Network Module -## Description -This topic displays help topics for the Azure Network Cmdlets. - -## AzureRM.Network Cmdlets -### [Add-AzureRmApplicationGatewayAuthenticationCertificate](Add-AzureRmApplicationGatewayAuthenticationCertificate.md) -Adds an authentication certificate to an application gateway. - -### [Add-AzureRmApplicationGatewayBackendAddressPool](Add-AzureRmApplicationGatewayBackendAddressPool.md) -Adds a back-end address pool to an application gateway. - -### [Add-AzureRmApplicationGatewayBackendHttpSettings](Add-AzureRmApplicationGatewayBackendHttpSettings.md) -Adds back-end HTTP settings to an application gateway. - -### [Add-AzureRmApplicationGatewayFrontendIPConfig](Add-AzureRmApplicationGatewayFrontendIPConfig.md) -Adds a front-end IP configuration to an application gateway. - -### [Add-AzureRmApplicationGatewayFrontendPort](Add-AzureRmApplicationGatewayFrontendPort.md) -Adds a front-end port to an application gateway. - -### [Add-AzureRmApplicationGatewayHttpListener](Add-AzureRmApplicationGatewayHttpListener.md) -Adds an HTTP listener to an application gateway. - -### [Add-AzureRmApplicationGatewayIPConfiguration](Add-AzureRmApplicationGatewayIPConfiguration.md) -Adds an IP configuration to an application gateway. - -### [Add-AzureRmApplicationGatewayProbeConfig](Add-AzureRmApplicationGatewayProbeConfig.md) -Adds a health probe to an Application Gateway. - -### [Add-AzureRmApplicationGatewayRedirectConfiguration](Add-AzureRmApplicationGatewayRedirectConfiguration.md) -Adds a redirect configuration to an Application Gateway. - -### [Add-AzureRmApplicationGatewayRequestRoutingRule](Add-AzureRmApplicationGatewayRequestRoutingRule.md) -Adds a request routing rule to an application gateway. - -### [Add-AzureRmApplicationGatewaySslCertificate](Add-AzureRmApplicationGatewaySslCertificate.md) -Adds an SSL certificate to an application gateway. - -### [Add-AzureRmApplicationGatewayUrlPathMapConfig](Add-AzureRmApplicationGatewayUrlPathMapConfig.md) -Adds an array of URL path mappings to a backend server pool. - -### [Add-AzureRmExpressRouteCircuitAuthorization](Add-AzureRmExpressRouteCircuitAuthorization.md) -Adds an ExpressRoute circuit authorization. - -### [Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) -Adds a peering configuration to an ExpressRoute circuit. - -### [Add-AzureRmLoadBalancerBackendAddressPoolConfig](Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Adds a backend address pool configuration to a load balancer. - -### [Add-AzureRmLoadBalancerFrontendIpConfig](Add-AzureRmLoadBalancerFrontendIpConfig.md) -Adds a front-end IP configuration to a load balancer. - -### [Add-AzureRmLoadBalancerInboundNatPoolConfig](Add-AzureRmLoadBalancerInboundNatPoolConfig.md) -{{Manually Enter Add-AzureRmLoadBalancerInboundNatPoolConfig Description Here}} - -### [Add-AzureRmLoadBalancerInboundNatRuleConfig](Add-AzureRmLoadBalancerInboundNatRuleConfig.md) -Adds an inbound NAT rule configuration to a load balancer. - -### [Add-AzureRmLoadBalancerProbeConfig](Add-AzureRmLoadBalancerProbeConfig.md) -Adds a probe configuration to a load balancer. - -### [Add-AzureRmLoadBalancerRuleConfig](Add-AzureRmLoadBalancerRuleConfig.md) -Adds a rule configuration to a load balancer. - -### [Add-AzureRmNetworkInterfaceIpConfig](Add-AzureRmNetworkInterfaceIpConfig.md) -Adds a network interface IP configuration to a network interface. - -### [Add-AzureRmNetworkSecurityRuleConfig](Add-AzureRmNetworkSecurityRuleConfig.md) -Adds a network security rule configuration to a network security group. - -### [Add-AzureRmRouteConfig](Add-AzureRmRouteConfig.md) -Adds a route to a route table. - -### [Add-AzureRmRouteFilterRuleConfig](Add-AzureRmRouteFilterRuleConfig.md) -Adds a route filter rule to a route filter. - -### [Add-AzureRmVirtualNetworkGatewayIpConfig](Add-AzureRmVirtualNetworkGatewayIpConfig.md) -Adds an IP configuration to a virtual network gateway. - -### [Add-AzureRmVirtualNetworkPeering](Add-AzureRmVirtualNetworkPeering.md) -Creates a peering between two virtual networks. - -### [Add-AzureRmVirtualNetworkSubnetConfig](Add-AzureRmVirtualNetworkSubnetConfig.md) -Adds a subnet configuration to a virtual network. - -### [Add-AzureRmVpnClientRevokedCertificate](Add-AzureRmVpnClientRevokedCertificate.md) -Adds a VPN client-revocation certificate. - -### [Add-AzureRmVpnClientRootCertificate](Add-AzureRmVpnClientRootCertificate.md) -Adds a VPN client root certificate. - -### [Get-AzureRmApplicationGateway](Get-AzureRmApplicationGateway.md) -Gets an application gateway. - -### [Get-AzureRmApplicationGatewayAuthenticationCertificate](Get-AzureRmApplicationGatewayAuthenticationCertificate.md) -Gets an authentication certificate for an application gateway. - -### [Get-AzureRmApplicationGatewayAvailableSslOptions](Get-AzureRmApplicationGatewayAvailableSslOptions.md) -Gets all available ssl options for ssl policy for Application Gateway. - -### [Get-AzureRmApplicationGatewayAvailableWafRuleSets](Get-AzureRmApplicationGatewayAvailableWafRuleSets.md) -Gets all available web application firewall rule sets. - -### [Get-AzureRmApplicationGatewayBackendAddressPool](Get-AzureRmApplicationGatewayBackendAddressPool.md) -Gets a back-end address pool for an application gateway. - -### [Get-AzureRmApplicationGatewayBackendHealth](Get-AzureRmApplicationGatewayBackendHealth.md) -Gets application gateway backend health. - -### [Get-AzureRmApplicationGatewayBackendHttpSettings](Get-AzureRmApplicationGatewayBackendHttpSettings.md) -Gets the back-end HTTP settings of an application gateway. - -### [Get-AzureRmApplicationGatewayConnectionDraining](Get-AzureRmApplicationGatewayConnectionDraining.md) -Gets the connection draining configuration of a back-end HTTP settings object. - -### [Get-AzureRmApplicationGatewayFrontendIPConfig](Get-AzureRmApplicationGatewayFrontendIPConfig.md) -Gets the front-end IP configuration of an application gateway. - -### [Get-AzureRmApplicationGatewayFrontendPort](Get-AzureRmApplicationGatewayFrontendPort.md) -Gets the front-end port of an application gateway. - -### [Get-AzureRmApplicationGatewayHttpListener](Get-AzureRmApplicationGatewayHttpListener.md) -Gets the HTTP listener of an application gateway. - -### [Get-AzureRmApplicationGatewayIPConfiguration](Get-AzureRmApplicationGatewayIPConfiguration.md) -Gets the IP configuration of an application gateway. - -### [Get-AzureRmApplicationGatewayProbeConfig](Get-AzureRmApplicationGatewayProbeConfig.md) -Gets an existing health probe configuration from an Application Gateway. - -### [Get-AzureRmApplicationGatewayRedirectConfiguration](Get-AzureRmApplicationGatewayRedirectConfiguration.md) -Gets an existing redirect configuration from an Application Gateway. - -### [Get-AzureRmApplicationGatewayRequestRoutingRule](Get-AzureRmApplicationGatewayRequestRoutingRule.md) -Gets the request routing rule of an application gateway. - -### [Get-AzureRmApplicationGatewaySku](Get-AzureRmApplicationGatewaySku.md) -Gets the SKU of an application gateway. - -### [Get-AzureRmApplicationGatewaySslCertificate](Get-AzureRmApplicationGatewaySslCertificate.md) -Gets an SSL certificate for an application gateway. - -### [Get-AzureRmApplicationGatewaySslPolicy](Get-AzureRmApplicationGatewaySslPolicy.md) -Gets the SSL policy of an application gateway. - -### [Get-AzureRmApplicationGatewaySslPredefinedPolicy](Get-AzureRmApplicationGatewaySslPredefinedPolicy.md) -Gets Predefined SSL Policies provided by Application Gateway. - -### [Get-AzureRmApplicationGatewayUrlPathMapConfig](Get-AzureRmApplicationGatewayUrlPathMapConfig.md) -Gets an array of URL path mappings to a backend server pool. - -### [Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Gets the WAF configuration of an application gateway. - -### [Get-AzureRmApplicationSecurityGroup](Get-AzureRmApplicationSecurityGroup.md) -Gets an application security group. - -### [Get-AzureRmBgpServiceCommunity](Get-AzureRmBgpServiceCommunity.md) -{{Manually Enter Get-AzureRmBgpServiceCommunity Description Here}} - -### [Get-AzureRmEffectiveNetworkSecurityGroup](Get-AzureRmEffectiveNetworkSecurityGroup.md) -Gets the effective network security group of a network interface. - -### [Get-AzureRmEffectiveRouteTable](Get-AzureRmEffectiveRouteTable.md) -Gets the effective route table of a network interface. - -### [Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) -Gets an Azure ExpressRoute circuit from Azure. - -### [Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) -Gets the ARP table from an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitAuthorization](Get-AzureRmExpressRouteCircuitAuthorization.md) -Gets information about ExpressRoute circuit authorizations. - -### [Get-AzureRmExpressRouteCircuitPeeringConfig](Get-AzureRmExpressRouteCircuitPeeringConfig.md) -Gets an ExpressRoute circuit peering configuration. - -### [Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) -Gets a route table from an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) -Gets a route table summary of an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) -Gets usage statistics of an ExpressRoute circuit. - -### [Get-AzureRmExpressRouteServiceProvider](Get-AzureRmExpressRouteServiceProvider.md) -Gets a list ExpressRoute service providers and their attributes. - -### [Get-AzureRmLoadBalancer](Get-AzureRmLoadBalancer.md) -Gets a load balancer. - -### [Get-AzureRmLoadBalancerBackendAddressPoolConfig](Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Gets a backend address pool configuration for a load balancer. - -### [Get-AzureRmLoadBalancerFrontendIpConfig](Get-AzureRmLoadBalancerFrontendIpConfig.md) -Gets a front-end IP configuration in a load balancer. - -### [Get-AzureRmLoadBalancerInboundNatPoolConfig](Get-AzureRmLoadBalancerInboundNatPoolConfig.md) -{{Manually Enter Get-AzureRmLoadBalancerInboundNatPoolConfig Description Here}} - -### [Get-AzureRmLoadBalancerInboundNatRuleConfig](Get-AzureRmLoadBalancerInboundNatRuleConfig.md) -Gets an inbound NAT rule configuration for a load balancer. - -### [Get-AzureRmLoadBalancerProbeConfig](Get-AzureRmLoadBalancerProbeConfig.md) -Gets a probe configuration for a load balancer. - -### [Get-AzureRmLoadBalancerRuleConfig](Get-AzureRmLoadBalancerRuleConfig.md) -Gets the rule configuration for a load balancer. - -### [Get-AzureRmLocalNetworkGateway](Get-AzureRmLocalNetworkGateway.md) -Gets a Local Network Gateway - -### [Get-AzureRmNetworkInterface](Get-AzureRmNetworkInterface.md) -Gets a network interface. - -### [Get-AzureRmNetworkInterfaceIpConfig](Get-AzureRmNetworkInterfaceIpConfig.md) -Gets a network interface IP configuration for a network interface. - -### [Get-AzureRmNetworkSecurityGroup](Get-AzureRmNetworkSecurityGroup.md) -Gets a network security group. - -### [Get-AzureRmNetworkSecurityRuleConfig](Get-AzureRmNetworkSecurityRuleConfig.md) -Get a network security rule configuration for a network security group. - -### [Get-AzureRmNetworkUsage](Get-AzureRmNetworkUsage.md) -Lists network usages for a subscription - -### [Get-AzureRmNetworkWatcher](Get-AzureRmNetworkWatcher.md) -Gets the properties of a Network Watcher - -### [Get-AzureRmNetworkWatcherFlowLogStatus](Get-AzureRmNetworkWatcherFlowLogStatus.md) -Gets the status of flow logging on a resource. - -### [Get-AzureRmNetworkWatcherNextHop](Get-AzureRmNetworkWatcherNextHop.md) -Gets the next hop from a VM. - -### [Get-AzureRmNetworkWatcherPacketCapture](Get-AzureRmNetworkWatcherPacketCapture.md) -Gets information and properties and status of a packet capture resource. - -### [Get-AzureRmNetworkWatcherReachabilityProvidersList](Get-AzureRmNetworkWatcherReachabilityProvidersList.md) -Lists all available internet service providers for a specified Azure region. - -### [Get-AzureRMNetworkWatcherReachabilityReport](Get-AzureRMNetworkWatcherReachabilityReport.md) -Gets the relative latency score for internet service providers from a specified location to Azure regions. - -### [Get-AzureRmNetworkWatcherSecurityGroupView](Get-AzureRmNetworkWatcherSecurityGroupView.md) -View the configured and effective network security group rules applied on a VM. - -### [Get-AzureRmNetworkWatcherTopology](Get-AzureRmNetworkWatcherTopology.md) -Gets a network level view of resources and their relationships in a resource group. - -### [Get-AzureRmNetworkWatcherTroubleshootingResult](Get-AzureRmNetworkWatcherTroubleshootingResult.md) -Gets the troubleshooting result from the previously run or currently running troubleshooting operation. - -### [Get-AzureRmPublicIpAddress](Get-AzureRmPublicIpAddress.md) -Gets a public IP address. - -### [Get-AzureRmRouteConfig](Get-AzureRmRouteConfig.md) -Gets routes from a route table. - -### [Get-AzureRmRouteFilter](Get-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmRouteFilterRuleConfig](Get-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Get-AzureRmRouteTable](Get-AzureRmRouteTable.md) -Gets route tables. - -### [Get-AzureRmVirtualNetwork](Get-AzureRmVirtualNetwork.md) -Gets a virtual network in a resource group. - -### [Get-AzureRmVirtualNetworkAvailableEndpointService](Get-AzureRmVirtualNetworkAvailableEndpointService.md) -Lists available endpoint services for location. - -### [Get-AzureRmVirtualNetworkGateway](Get-AzureRmVirtualNetworkGateway.md) -Gets a Virtual Network Gateway - -### [Get-AzureRmVirtualNetworkGatewayAdvertisedRoute](Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md) -Lists routes being advertised by an Azure virtual network gateway - -### [Get-AzureRmVirtualNetworkGatewayBGPPeerStatus](Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md) -Lists an Azure virtual network gateway's BGP peers - -### [Get-AzureRmVirtualNetworkGatewayConnection](Get-AzureRmVirtualNetworkGatewayConnection.md) -Gets a Virtual Network Gateway Connection - -### [Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -{{Manually Enter Get-AzureRmVirtualNetworkGatewayConnectionSharedKey Description Here}} - -### [Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript](Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md) -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -### [Get-AzureRmVirtualNetworkGatewayLearnedRoute](Get-AzureRmVirtualNetworkGatewayLearnedRoute.md) -Lists routes learned by an Azure virtual network gateway - -### [Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice](Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md) -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -### [Get-AzureRmVirtualNetworkPeering](Get-AzureRmVirtualNetworkPeering.md) -Gets the virtual network peering. - -### [Get-AzureRmVirtualNetworkSubnetConfig](Get-AzureRmVirtualNetworkSubnetConfig.md) -Gets a subnet in a virtual network. - -### [Get-AzureRmVirtualNetworkUsageList](Get-AzureRmVirtualNetworkUsageList.md) -Gets virtual network current usage. - -### [Get-AzureRmVpnClientConfiguration](Get-AzureRmVpnClientConfiguration.md) -Allows users to easily download the Vpn Profile package that was generated using the New-AzureRmVpnClientConfiguration commandlet. - -### [Get-AzureRmVpnClientPackage](Get-AzureRmVpnClientPackage.md) -Gets information about a VPN client package. - -### [Get-AzureRmVpnClientRevokedCertificate](Get-AzureRmVpnClientRevokedCertificate.md) -Gets information about VPN client-revocation certificates. - -### [Get-AzureRmVpnClientRootCertificate](Get-AzureRmVpnClientRootCertificate.md) -Gets information about VPN root certificates. - -### [Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) -Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. - -### [New-AzureRmApplicationGateway](New-AzureRmApplicationGateway.md) -Creates an application gateway. - -### [New-AzureRmApplicationGatewayAuthenticationCertificate](New-AzureRmApplicationGatewayAuthenticationCertificate.md) -Creates an authentication certificate for an application gateway. - -### [New-AzureRmApplicationGatewayBackendAddressPool](New-AzureRmApplicationGatewayBackendAddressPool.md) -Creates a back-end address pool for an application gateway. - -### [New-AzureRmApplicationGatewayBackendHttpSettings](New-AzureRmApplicationGatewayBackendHttpSettings.md) -Creates back-end HTTP settings for an application gateway. - -### [New-AzureRmApplicationGatewayConnectionDraining](New-AzureRmApplicationGatewayConnectionDraining.md) -Creates a new connection draining configuration for back-end HTTP settings. - -### [New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig](New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md) -Creates a new disabled rule group configuration. - -### [New-AzureRmApplicationGatewayFrontendIPConfig](New-AzureRmApplicationGatewayFrontendIPConfig.md) -Creates a front-end IP configuration for an application gateway. - -### [New-AzureRmApplicationGatewayFrontendPort](New-AzureRmApplicationGatewayFrontendPort.md) -Creates a front-end port for an application gateway. - -### [New-AzureRmApplicationGatewayHttpListener](New-AzureRmApplicationGatewayHttpListener.md) -Creates an HTTP listener for an application gateway. - -### [New-AzureRmApplicationGatewayIPConfiguration](New-AzureRmApplicationGatewayIPConfiguration.md) -Creates an IP configuration for an application gateway. - -### [New-AzureRmApplicationGatewayPathRuleConfig](New-AzureRmApplicationGatewayPathRuleConfig.md) -Creates an application gateway path rule. - -### [New-AzureRmApplicationGatewayProbeConfig](New-AzureRmApplicationGatewayProbeConfig.md) -Creates a health probe. - -### [New-AzureRmApplicationGatewayProbeHealthResponseMatch](New-AzureRmApplicationGatewayProbeHealthResponseMatch.md) -Creates a health probe response match used by Health Probe for an application gateway. - -### [New-AzureRmApplicationGatewayRedirectConfiguration](New-AzureRmApplicationGatewayRedirectConfiguration.md) -Creates a redirect configuration for an application gateway. - -### [New-AzureRmApplicationGatewayRequestRoutingRule](New-AzureRmApplicationGatewayRequestRoutingRule.md) -Creates a request routing rule for an application gateway. - -### [New-AzureRmApplicationGatewaySku](New-AzureRmApplicationGatewaySku.md) -Creates a SKU for an application gateway. - -### [New-AzureRmApplicationGatewaySslCertificate](New-AzureRmApplicationGatewaySslCertificate.md) -Creates an SSL certificate for an Azure application gateway. - -### [New-AzureRmApplicationGatewaySslPolicy](New-AzureRmApplicationGatewaySslPolicy.md) -Creates an SSL policy for an application gateway. - -### [New-AzureRmApplicationGatewayUrlPathMapConfig](New-AzureRmApplicationGatewayUrlPathMapConfig.md) -Creates an array of URL path mappings to a backend server pool. - -### [New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Creates a WAF configuration for an application gateway. - -### [New-AzureRmApplicationSecurityGroup](New-AzureRmApplicationSecurityGroup.md) -Creates an application security group. - -### [New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) -Creates an Azure express route circuit. - -### [New-AzureRmExpressRouteCircuitAuthorization](New-AzureRmExpressRouteCircuitAuthorization.md) -Creates an ExpressRoute circuit authorization. - -### [New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) -Creates a new peering configuration to be added to an ExpressRoute circuit. - -### [New-AzureRmIpsecPolicy](New-AzureRmIpsecPolicy.md) -Creates an IPSec Policy. - -### [New-AzureRmLoadBalancer](New-AzureRmLoadBalancer.md) -Creates a load balancer. - -### [New-AzureRmLoadBalancerBackendAddressPoolConfig](New-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Creates a backend address pool configuration for a load balancer. - -### [New-AzureRmLoadBalancerFrontendIpConfig](New-AzureRmLoadBalancerFrontendIpConfig.md) -Creates a front-end IP configuration for a load balancer. - -### [New-AzureRmLoadBalancerInboundNatPoolConfig](New-AzureRmLoadBalancerInboundNatPoolConfig.md) -{{Manually Enter New-AzureRmLoadBalancerInboundNatPoolConfig Description Here}} - -### [New-AzureRmLoadBalancerInboundNatRuleConfig](New-AzureRmLoadBalancerInboundNatRuleConfig.md) -Creates an inbound NAT rule configuration for a load balancer. - -### [New-AzureRmLoadBalancerProbeConfig](New-AzureRmLoadBalancerProbeConfig.md) -Creates a probe configuration for a load balancer. - -### [New-AzureRmLoadBalancerRuleConfig](New-AzureRmLoadBalancerRuleConfig.md) -Creates a rule configuration for a load balancer. - -### [New-AzureRmLocalNetworkGateway](New-AzureRmLocalNetworkGateway.md) -Creates a Local Network Gateway - -### [New-AzureRmNetworkInterface](New-AzureRmNetworkInterface.md) -Creates a network interface. - -### [New-AzureRmNetworkInterfaceIpConfig](New-AzureRmNetworkInterfaceIpConfig.md) -Creates a network interface IP configuration. - -### [New-AzureRmNetworkSecurityGroup](New-AzureRmNetworkSecurityGroup.md) -Creates a network security group. - -### [New-AzureRmNetworkSecurityRuleConfig](New-AzureRmNetworkSecurityRuleConfig.md) -Creates a network security rule configuration. - -### [New-AzureRmNetworkWatcher](New-AzureRmNetworkWatcher.md) -Creates a new Network Watcher resource. - -### [New-AzureRmNetworkWatcherPacketCapture](New-AzureRmNetworkWatcherPacketCapture.md) -Creates a new packet capture resource and starts a packet capture session on a VM. - -### [New-AzureRmPacketCaptureFilterConfig](New-AzureRmPacketCaptureFilterConfig.md) -Creates a new packet capture filter object. - -### [New-AzureRmPublicIpAddress](New-AzureRmPublicIpAddress.md) -Creates a public IP address. - -### [New-AzureRmRouteConfig](New-AzureRmRouteConfig.md) -Creates a route for a route table. - -### [New-AzureRmRouteFilter](New-AzureRmRouteFilter.md) -Creates a route filter. - -### [New-AzureRmRouteFilterRuleConfig](New-AzureRmRouteFilterRuleConfig.md) -Creates a route filter rule for a route filter. - -### [New-AzureRmRouteTable](New-AzureRmRouteTable.md) -Creates a route table. - -### [New-AzureRmVirtualNetwork](New-AzureRmVirtualNetwork.md) -Creates a virtual network. - -### [New-AzureRmVirtualNetworkGateway](New-AzureRmVirtualNetworkGateway.md) -Creates a Virtual Network Gateway - -### [New-AzureRmVirtualNetworkGatewayConnection](New-AzureRmVirtualNetworkGatewayConnection.md) -{{Manually Enter New-AzureRmVirtualNetworkGatewayConnection Description Here}} - -### [New-AzureRmVirtualNetworkGatewayIpConfig](New-AzureRmVirtualNetworkGatewayIpConfig.md) -Creates an IP Configuration for a Virtual Network Gateway - -### [New-AzureRmVirtualNetworkSubnetConfig](New-AzureRmVirtualNetworkSubnetConfig.md) -Creates a virtual network subnet configuration. - -### [New-AzureRmVpnClientConfiguration](New-AzureRmVpnClientConfiguration.md) -This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -### [New-AzureRmVpnClientRevokedCertificate](New-AzureRmVpnClientRevokedCertificate.md) -Creates a new VPN client-revocation certificate. - -### [New-AzureRmVpnClientRootCertificate](New-AzureRmVpnClientRootCertificate.md) -Creates a new VPN client root certificate. - -### [Remove-AzureRmApplicationGateway](Remove-AzureRmApplicationGateway.md) -Removes an application gateway. - -### [Remove-AzureRmApplicationGatewayAuthenticationCertificate](Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) -Removes an authentication certificate from an application gateway. - -### [Remove-AzureRmApplicationGatewayBackendAddressPool](Remove-AzureRmApplicationGatewayBackendAddressPool.md) -Removes a back-end address pool from an application gateway. - -### [Remove-AzureRmApplicationGatewayBackendHttpSettings](Remove-AzureRmApplicationGatewayBackendHttpSettings.md) -Removes back-end HTTP settings from an application gateway. - -### [Remove-AzureRmApplicationGatewayConnectionDraining](Remove-AzureRmApplicationGatewayConnectionDraining.md) -Removes the connection draining configuration of a back-end HTTP settings object. - -### [Remove-AzureRmApplicationGatewayFrontendIPConfig](Remove-AzureRmApplicationGatewayFrontendIPConfig.md) -Removes a front-end IP configuration from an application gateway. - -### [Remove-AzureRmApplicationGatewayFrontendPort](Remove-AzureRmApplicationGatewayFrontendPort.md) -Removes a front-end port from an application gateway. - -### [Remove-AzureRmApplicationGatewayHttpListener](Remove-AzureRmApplicationGatewayHttpListener.md) -Removes an HTTP listener from an application gateway. - -### [Remove-AzureRmApplicationGatewayIPConfiguration](Remove-AzureRmApplicationGatewayIPConfiguration.md) -Removes an IP configuration from an application gateway. - -### [Remove-AzureRmApplicationGatewayProbeConfig](Remove-AzureRmApplicationGatewayProbeConfig.md) -Removes a health probe from an existing application gateway. - -### [Remove-AzureRmApplicationGatewayRedirectConfiguration](Remove-AzureRmApplicationGatewayRedirectConfiguration.md) -Removes a redirect configuration from an existing Application Gateway. - -### [Remove-AzureRmApplicationGatewayRequestRoutingRule](Remove-AzureRmApplicationGatewayRequestRoutingRule.md) -Removes a request routing rule from an application gateway. - -### [Remove-AzureRmApplicationGatewaySslCertificate](Remove-AzureRmApplicationGatewaySslCertificate.md) -Removes an SSL certificate from an Azure application gateway. - -### [Remove-AzureRmApplicationGatewaySslPolicy](Remove-AzureRmApplicationGatewaySslPolicy.md) -Removes an SSL policy from an Azure application gateway. - -### [Remove-AzureRmApplicationGatewayUrlPathMapConfig](Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) -Removes URL path mappings to a backend server pool. - -### [Remove-AzureRmApplicationSecurityGroup](Remove-AzureRmApplicationSecurityGroup.md) -Removes an application security group. - -### [Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) -Removes an ExpressRoute circuit. - -### [Remove-AzureRmExpressRouteCircuitAuthorization](Remove-AzureRmExpressRouteCircuitAuthorization.md) -Removes an existing ExpressRoute configuration authorization. - -### [Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) -Removes an ExpressRoute circuit peering configuration. - -### [Remove-AzureRmLoadBalancer](Remove-AzureRmLoadBalancer.md) -Removes a load balancer. - -### [Remove-AzureRmLoadBalancerBackendAddressPoolConfig](Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) -Removes a backend address pool configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerFrontendIpConfig](Remove-AzureRmLoadBalancerFrontendIpConfig.md) -Removes a front-end IP configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerInboundNatPoolConfig](Remove-AzureRmLoadBalancerInboundNatPoolConfig.md) -{{Manually Enter Remove-AzureRmLoadBalancerInboundNatPoolConfig Description Here}} - -### [Remove-AzureRmLoadBalancerInboundNatRuleConfig](Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) -Removes an inbound NAT rule configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerProbeConfig](Remove-AzureRmLoadBalancerProbeConfig.md) -Removes a probe configuration from a load balancer. - -### [Remove-AzureRmLoadBalancerRuleConfig](Remove-AzureRmLoadBalancerRuleConfig.md) -Removes a rule configuration for a load balancer. - -### [Remove-AzureRmLocalNetworkGateway](Remove-AzureRmLocalNetworkGateway.md) -Deletes a Local Network Gateway - -### [Remove-AzureRmNetworkInterface](Remove-AzureRmNetworkInterface.md) -Removes a network interface. - -### [Remove-AzureRmNetworkInterfaceIpConfig](Remove-AzureRmNetworkInterfaceIpConfig.md) -Removes a network interface IP configuration from a network interface. - -### [Remove-AzureRmNetworkSecurityGroup](Remove-AzureRmNetworkSecurityGroup.md) -Removes a network security group. - -### [Remove-AzureRmNetworkSecurityRuleConfig](Remove-AzureRmNetworkSecurityRuleConfig.md) -Removes a network security rule from a network security group. - -### [Remove-AzureRmNetworkWatcher](Remove-AzureRmNetworkWatcher.md) -Removes a Network Watcher. - -### [Remove-AzureRmNetworkWatcherPacketCapture](Remove-AzureRmNetworkWatcherPacketCapture.md) -Removes a packet capture resource. - -### [Remove-AzureRmPublicIpAddress](Remove-AzureRmPublicIpAddress.md) -Removes a public IP address. - -### [Remove-AzureRmRouteConfig](Remove-AzureRmRouteConfig.md) -Removes a route from a route table. - -### [Remove-AzureRmRouteFilter](Remove-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmRouteFilterRuleConfig](Remove-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Remove-AzureRmRouteTable](Remove-AzureRmRouteTable.md) -Removes a route table. - -### [Remove-AzureRmVirtualNetwork](Remove-AzureRmVirtualNetwork.md) -Removes a virtual network. - -### [Remove-AzureRmVirtualNetworkGateway](Remove-AzureRmVirtualNetworkGateway.md) -Deletes a Virtual Network Gateway - -### [Remove-AzureRmVirtualNetworkGatewayConnection](Remove-AzureRmVirtualNetworkGatewayConnection.md) -Deletes a Virtual Network Gateway Connection - -### [Remove-AzureRmVirtualNetworkGatewayDefaultSite](Remove-AzureRmVirtualNetworkGatewayDefaultSite.md) -Removes the default site from a virtual network gateway. - -### [Remove-AzureRmVirtualNetworkGatewayIpConfig](Remove-AzureRmVirtualNetworkGatewayIpConfig.md) -{{Manually Enter Remove-AzureRmVirtualNetworkGatewayIpConfig Description Here}} - -### [Remove-AzureRmVirtualNetworkPeering](Remove-AzureRmVirtualNetworkPeering.md) -{{Manually Enter Remove-AzureRmVirtualNetworkPeering Description Here}} - -### [Remove-AzureRmVirtualNetworkSubnetConfig](Remove-AzureRmVirtualNetworkSubnetConfig.md) -Removes a subnet configuration from a virtual network. - -### [Remove-AzureRmVpnClientRevokedCertificate](Remove-AzureRmVpnClientRevokedCertificate.md) -Removes a VPN client-revocation certificate. - -### [Remove-AzureRmVpnClientRootCertificate](Remove-AzureRmVpnClientRootCertificate.md) -Removes an existing VPN client root certificate. - -### [Reset-AzureRmVirtualNetworkGateway](Reset-AzureRmVirtualNetworkGateway.md) -{{Manually Enter Reset-AzureRmVirtualNetworkGateway Description Here}} - -### [Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey](Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -{{Manually Enter Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey Description Here}} - -### [Resize-AzureRmVirtualNetworkGateway](Resize-AzureRmVirtualNetworkGateway.md) -Resizes an existing virtual network gateway. - -### [Set-AzureRmApplicationGateway](Set-AzureRmApplicationGateway.md) -Updates an application gateway. - -### [Set-AzureRmApplicationGatewayAuthenticationCertificate](Set-AzureRmApplicationGatewayAuthenticationCertificate.md) -Updates an authentication certificate for an application gateway. - -### [Set-AzureRmApplicationGatewayBackendAddressPool](Set-AzureRmApplicationGatewayBackendAddressPool.md) -Updates a back-end address pool for an application gateway. - -### [Set-AzureRmApplicationGatewayBackendHttpSettings](Set-AzureRmApplicationGatewayBackendHttpSettings.md) -Updates back-end HTTP settings for an application gateway. - -### [Set-AzureRmApplicationGatewayConnectionDraining](Set-AzureRmApplicationGatewayConnectionDraining.md) -Modifies the connection draining configuration of a back-end HTTP settings object. - -### [Set-AzureRmApplicationGatewayFrontendIPConfig](Set-AzureRmApplicationGatewayFrontendIPConfig.md) -Modifies a front-end IP address configuration. - -### [Set-AzureRmApplicationGatewayFrontendPort](Set-AzureRmApplicationGatewayFrontendPort.md) -Modifies a front-end port for an application gateway. - -### [Set-AzureRmApplicationGatewayHttpListener](Set-AzureRmApplicationGatewayHttpListener.md) -Modifies an HTTP listener for an application gateway. - -### [Set-AzureRmApplicationGatewayIPConfiguration](Set-AzureRmApplicationGatewayIPConfiguration.md) -Modifies an IP configuration for an application gateway. - -### [Set-AzureRmApplicationGatewayProbeConfig](Set-AzureRmApplicationGatewayProbeConfig.md) -Sets the health probe configuration on an existing Application Gateway. - -### [Set-AzureRmApplicationGatewayRedirectConfiguration](Set-AzureRmApplicationGatewayRedirectConfiguration.md) -Sets the redirect configuration on an existing Application Gateway. - -### [Set-AzureRmApplicationGatewayRequestRoutingRule](Set-AzureRmApplicationGatewayRequestRoutingRule.md) -Modifies a request routing rule for an application gateway. - -### [Set-AzureRmApplicationGatewaySku](Set-AzureRmApplicationGatewaySku.md) -Modifies the SKU of an application gateway. - -### [Set-AzureRmApplicationGatewaySslCertificate](Set-AzureRmApplicationGatewaySslCertificate.md) -Sets the goal state of an SSL certificate. - -### [Set-AzureRmApplicationGatewaySslPolicy](Set-AzureRmApplicationGatewaySslPolicy.md) -Modifies the SSL policy of an application gateway. - -### [Set-AzureRmApplicationGatewayUrlPathMapConfig](Set-AzureRmApplicationGatewayUrlPathMapConfig.md) -Sets configuration for an array of URL path mappings to a backend server pool. - -### [Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) -Modifies the WAF configuration of an application gateway. - -### [Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) -Modifies an ExpressRoute circuit. - -### [Set-AzureRmExpressRouteCircuitPeeringConfig](Set-AzureRmExpressRouteCircuitPeeringConfig.md) -Saves a modified ExpressRoute peering configuration. - -### [Set-AzureRmLoadBalancer](Set-AzureRmLoadBalancer.md) -Sets the goal state for a load balancer. - -### [Set-AzureRmLoadBalancerFrontendIpConfig](Set-AzureRmLoadBalancerFrontendIpConfig.md) -Sets the goal state for a front-end IP configuration in a load balancer. - -### [Set-AzureRmLoadBalancerInboundNatPoolConfig](Set-AzureRmLoadBalancerInboundNatPoolConfig.md) -{{Manually Enter Set-AzureRmLoadBalancerInboundNatPoolConfig Description Here}} - -### [Set-AzureRmLoadBalancerInboundNatRuleConfig](Set-AzureRmLoadBalancerInboundNatRuleConfig.md) -Sets an inbound NAT rule configuration for a load balancer. - -### [Set-AzureRmLoadBalancerProbeConfig](Set-AzureRmLoadBalancerProbeConfig.md) -Sets the goal state for a probe configuration. - -### [Set-AzureRmLoadBalancerRuleConfig](Set-AzureRmLoadBalancerRuleConfig.md) -Sets the goal state for a load balancer rule configuration. - -### [Set-AzureRmLocalNetworkGateway](Set-AzureRmLocalNetworkGateway.md) -Modifies a local network gateway. - -### [Set-AzureRmNetworkInterface](Set-AzureRmNetworkInterface.md) -Sets the goal state for a network interface. - -### [Set-AzureRmNetworkInterfaceIpConfig](Set-AzureRmNetworkInterfaceIpConfig.md) -Sets the goal state for an Azure network interface IP configuration. - -### [Set-AzureRmNetworkSecurityGroup](Set-AzureRmNetworkSecurityGroup.md) -Sets the goal state for a network security group. - -### [Set-AzureRmNetworkSecurityRuleConfig](Set-AzureRmNetworkSecurityRuleConfig.md) -Sets the goal state for a network security rule configuration. - -### [Set-AzureRmNetworkWatcherConfigFlowLog](Set-AzureRmNetworkWatcherConfigFlowLog.md) -Configures flow logging for a target resource. - -### [Set-AzureRmPublicIpAddress](Set-AzureRmPublicIpAddress.md) -Sets the goal state for a public IP address. - -### [Set-AzureRmRouteConfig](Set-AzureRmRouteConfig.md) -Sets the goal state for a route. - -### [Set-AzureRmRouteFilter](Set-AzureRmRouteFilter.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmRouteFilterRuleConfig](Set-AzureRmRouteFilterRuleConfig.md) -{{Fill in the Synopsis}} - -### [Set-AzureRmRouteTable](Set-AzureRmRouteTable.md) -Sets the goal state for a route table. - -### [Set-AzureRmVirtualNetwork](Set-AzureRmVirtualNetwork.md) -Sets the goal state for a virtual network. - -### [Set-AzureRmVirtualNetworkGateway](Set-AzureRmVirtualNetworkGateway.md) -Updates a virtual network gateway. - -### [Set-AzureRmVirtualNetworkGatewayConnection](Set-AzureRmVirtualNetworkGatewayConnection.md) -Configures a virtual network gateway connection. - -### [Set-AzureRmVirtualNetworkGatewayConnectionSharedKey](Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) -Configures the shared key of the virtual network gateway connection. - -### [Set-AzureRmVirtualNetworkGatewayDefaultSite](Set-AzureRmVirtualNetworkGatewayDefaultSite.md) -Sets the default site for a virtual network gateway. - -### [Set-AzureRmVirtualNetworkGatewayVpnClientConfig](Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) -Sets the VPN client address pool for a virtual network gateway. - -### [Set-AzureRmVirtualNetworkPeering](Set-AzureRmVirtualNetworkPeering.md) -Configures a virtual network peering. - -### [Set-AzureRmVirtualNetworkSubnetConfig](Set-AzureRmVirtualNetworkSubnetConfig.md) -Configures the goal state for a subnet configuration in a virtual network. - -### [Start-AzureRmApplicationGateway](Start-AzureRmApplicationGateway.md) -Starts an application gateway. - -### [Start-AzureRmNetworkWatcherResourceTroubleshooting](Start-AzureRmNetworkWatcherResourceTroubleshooting.md) -Starts troubleshooting on a Networking resource in Azure. - -### [Stop-AzureRmApplicationGateway](Stop-AzureRmApplicationGateway.md) -Stops an application gateway - -### [Stop-AzureRmNetworkWatcherPacketCapture](Stop-AzureRmNetworkWatcherPacketCapture.md) -Stops a running packet capture session - -### [Test-AzureRmDnsAvailability](Test-AzureRmDnsAvailability.md) -{{Manually Enter Test-AzureRmDnsAvailability Description Here}} - -### [Test-AzureRmNetworkWatcherConnectivity](Test-AzureRmNetworkWatcherConnectivity.md) -Returns connectivity information for a specified source VM and a destination. - -### [Test-AzureRmNetworkWatcherIPFlow](Test-AzureRmNetworkWatcherIPFlow.md) -Returns whether the packet is allowed or denied to or from a particular destination. - -### [Test-AzureRmPrivateIPAddressAvailability](Test-AzureRmPrivateIPAddressAvailability.md) -Test availability of a private IP address in a virtual network. - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRMNetworkWatcherReachabilityReport.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRMNetworkWatcherReachabilityReport.md deleted file mode 100644 index 40e0265b80..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRMNetworkWatcherReachabilityReport.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherreachabilityreport -schema: 2.0.0 ---- - -# Get-AzureRMNetworkWatcherReachabilityReport - -## SYNOPSIS -Gets the relative latency score for internet service providers from a specified location to Azure regions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRMNetworkWatcherReachabilityReport -NetworkWatcherName <String> -ResourceGroupName <String> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRMNetworkWatcherReachabilityReport -NetworkWatcher <PSNetworkWatcher> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRMNetworkWatcherReachabilityReport -ResourceId <String> - [-Provider <System.Collections.Generic.List`1[System.String]>] - [-Location <System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> -EndTime <DateTime> - [-Country <String>] [-State <String>] [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherReachabilityReport gets the relative latency score for internet service providers from a specified location to Azure regions. - -## EXAMPLES - -### Example 1 -``` -$nw = Get-AzureRmNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG -Get-AzureRmNetworkWatcherReachabilityReport -NetworkWatcher $nw -Location "West US" -Country "United States" -StartTime "2017-10-10" -EndTime "2017-10-12" - -"aggregationLevel" : "Country", -"providerLocation" : { - "country" : "United States" -}, -"reachabilityReport" : [ - { - "provider" : "Frontier Communications of America, Inc. - ASN 5650", - "azureLocation": "West US", - "latencies": [ - { - "timeStamp": "2017-10-10T00:00:00Z", - "score": 94 - }, - { - "timeStamp": "2017-10-11T00:00:00Z", - "score": 94 - }, - { - "timeStamp": "2017-10-12T00:00:00Z", - "score": 94 - } - ] - } -] -``` - -Gets relative latencies to Azure Data Center in West US from 2017-10-10 to 2017-10-12 inside United State. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The name of the city. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -The name of the country. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -The end time for the Azure reachability report. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Optional Azure regions to scope the query to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: ResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -List of Internet service providers. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Id of network watcher resource. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -The start time for the Azure reachability report. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -The name of the state. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAzureReachabilityReport - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, reachability, report - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGateway.md deleted file mode 100644 index a6fd896a9c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGateway.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 77CDEE77-FD5D-4C2D-B027-FF1F6FF6618E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgateway -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGateway - -## SYNOPSIS -Gets an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGateway [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGateway** cmdlet gets an application gateway. - -## EXAMPLES - -### Example 1: Get a specified application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -``` - -This command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -### Example 2: Get a list of application gateways in a resource group -``` -PS C:\>$AppGwList = Get-AzureRmApplicationGateway -ResourceGroupName "ResourceGroup01" -``` - -This command gets a list of all the application gateways in the resource group named ResourceGroup01 and stores it in the $AppGwList variable. - -### Example 3: Get a list of application gateways in a subscription -``` -PS C:\>$AppGwList = Get-AzureRmApplicationGateway -``` - -This command gets a list of all the application gateways in the subscription and stores it in the $AppGwList variable. - -## 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 -Specifies the name of the application gateway that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmApplicationGateway](./Stop-AzureRmApplicationGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 814eca491a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 706C918B-1D1A-476C-BB74-EBB4EE72AC0C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Gets an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAuthenticationCertificate [-Name <String>] - -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet gets an authentication certificate for an Azure application gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet gets an authentication certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the authentication certificate that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md deleted file mode 100644 index e72f31efa8..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableSslOptions.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayavailablessloptions -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayAvailableSslOptions - -## SYNOPSIS -Gets all available ssl options for ssl policy for Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAvailableSslOptions [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAvailableSslOptions** cmdlet gets all available ssl options for ssl policy - -## EXAMPLES - -### Example 1 -``` -PS C:\>$sslOptions = Get-AzureRmApplicationGatewayAvailableSslOptions -``` - -This commands returns all available ssl options for ssl policy. - -## 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 -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableSslOptions - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md deleted file mode 100644 index 0a88a774e3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayAvailableWafRuleSets.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayavailablewafrulesets -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayAvailableWafRuleSets - -## SYNOPSIS -Gets all available web application firewall rule sets. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayAvailableWafRuleSets [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayAvailableWafRuleSets** cmdlet gets all available web application firewall rule sets. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$availableRuleSets = Get-AzureRmApplicationGatewayAvailableWafRuleSets -``` - -This commands returns all the available web application firewall rule sets. - -## 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 -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAvailableWafRuleSetsResult - -## NOTES -**List-AzureRmApplicationGatewayAvailableWafRuleSets** is an alias for the **Get-AzureRmApplicationGatewayAvailableWafRuleSets** cmdlet. - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index 7afd095176..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4B2066B6-51D7-46D8-8A72-1A232B3E6589 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Gets a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendAddressPool [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1: Get a specified back-end server pool -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $BackendPool = Get-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end address pool associated with $AppGw named Pool01 and stores it in the $BackendPool variable. - -### Example 2: Get a list of back-end server pool -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $BackendPools = Get-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets a list of the back-end address pools associated with $AppGw, and stores the list in the $BackendPools variable. - -## PARAMETERS - -### -ApplicationGateway -The **Get-AzureRmApplicationGatewayBackendAddressPool** cmdlet gets a back-end address pool for an application gateway. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the back-end address pool that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHealth.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHealth.md deleted file mode 100644 index cb88e9a76b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHealth.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D5E928C3-26B6-4B7C-8A9C-F1F602BABF75 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendhealth -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayBackendHealth - -## SYNOPSIS -Gets application gateway backend health. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendHealth -Name <String> -ResourceGroupName <String> - [-ExpandResource <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayBackendHealth cmdlet gets application gateway backend health. - -## EXAMPLES - -### -------------------------- Example 1: Gets backend health without expanded resources. -------------------------- -``` -PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -``` - -This command gets the backend health of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. - -### -------------------------- Example 1: Gets backend health with expanded resources. -------------------------- -``` -PS C:\>$BackendHealth = Get-AzureRmApplicationGatewayBackendHealth -Name ApplicationGateway01 -ResourceGroupName ResourceGroup01 -ExpandResource "backendhealth/applicationgatewayresource" -``` - -This command gets the backend health (with expanded resources) of application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $BackendHealth variable. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandResource -```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 application gateway that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHealth - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index 1aa111ec86..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Gets the back-end HTTP settings of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayBackendHttpSettings [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet gets the back-end HTTP settings of an application gateway. - -## EXAMPLES - -### Example 1: Get back-end HTTP settings by name -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. - -### Example 2: Get a collection of back-end HTTP settings -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $SettingsList = Get-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the collection of HTTP settings for $AppGw and stores the settings in the $SettingsList variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object that contains back-end HTTP settings. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the backend HTTP settings that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.AzureApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index eee7d0010f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Gets the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayConnectionDraining** cmdlet gets the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> $ConnectionDraining = Get-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $Settings -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command gets the connection draining configuration from the back-end HTTP settings $Settings and stores it in the $ConnectionDraining variable. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index f36209c8ff..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 364C41D0-A5DB-4AEF-853A-FE5A11AD9155 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Gets the front-end IP configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayFrontendIPConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayFrontendIPConfig** cmdlet gets the front-end IP configuration of an application gateway. - -## EXAMPLES - -### Example 1: Get a specified front-end IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndIP= Get-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets the front-end IP configuration named FrontEndIP01 from $AppGw and stores it in the $FrontEndIP variable. - -### Example 2: Get a list of front-end IP configurations -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndIPs= Get-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable.The second command gets a list of the front-end IP configurations from $AppGw and stores it in the $FrontEndIPs variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the front-end IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end IP configuration that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendPort.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index f2a0ff89f0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4518D2A9-7DE7-4617-86E0-7778B8CFE48C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayfrontendport -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Gets the front-end port of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayFrontendPort [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayFrontendPort** cmdlet gets the front-end port of an application gateway. - -## EXAMPLES - -### Example 1: Get a specified front-end port -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndPort = Get-AzureRmApplicationGatewayFrontendIPort -Name "FrontEndPort01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command gets the front-end port named FrontEndPort01 from $AppGw and stores it in the $FrontEndPort variable. - -### Example 2: Get a list of front-end ports -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FrontEndPorts = Get-AzureRmApplicationGatewayFrontendIPort -ApplicationGateway $AppGw -``` - -The first command gets an application gateway named ApplicationGateway01 from the resource group named ResourceGroup01, and stores it in the $AppGw variable. -The second command gets a list of the front-end ports from $AppGw and stores it in the $FrontEndPorts variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the front-end port. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end port to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayHttpListener.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index 4a128c8061..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 8D41EDAC-17D9-494B-8336-67906F4E1E81 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayhttplistener -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Gets the HTTP listener of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayHttpListener [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayHttpListener** cmdlet gets the HTTP listener of an application gateway. - -## EXAMPLES - -### Example 1: Get a specific HTTP listener -``` -PS C:\>$Appgw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Listener = Get-AzureRmApplicationGatewayHttpListener -Name "Listener01" -ApplicationGateway $Appgw -``` - -This command gets an HTTP listener named Listener01. - -### Example 2: Get a list of HTTP listeners -``` -PS C:\>$Appgw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Listeners = Get-AzureRmApplicationGatewayHttpListener -ApplicationGateway $Appgw -``` - -This command gets a list of HTTP listeners. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the HTTP listener. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the HTTP listener which this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index c7c2040044..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 35562212-283C-4BB2-8B12-C3617A6760D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayipconfiguration -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Gets the IP configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayIPConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayIPConfiguration** cmdlet gets the IP configuration of an application gateway. -The IP configuration contains the subnet in which the application gateway is deployed. - -## EXAMPLES - -### Example 1: Get a specific IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $GatewaySubnet = Get-AzureRmApplicationGatewayIPConfiguration -Name "GatewaySubnet01" -ApplicationGateway $AppGw -``` - -The first command gets an application gateway and stores it in the $AppGw variable.The second command gets an IP configuration named GateSubnet01 from the gateway stored in $AppGw. - -### Example 2: Get a list of IP configurations -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $GatewaySubnets = Get-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -``` - -The first command gets an application gateway and stores it in the $AppGw variable.The second command gets a list of all IP configurations. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the IP configuration which this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index c27e75e683..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayprobeconfig -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Gets an existing health probe configuration from an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayProbeConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmApplicationGatewayProbeConfig cmdlet gets an existing health probe configuration from an Application Gateway. - -## EXAMPLES - -### Example 1: Get an existing probe from an application gateway -``` -PS C:\>Get-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe02" -``` - -This command gets the health probe named Probe02 from the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet gets a probe configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe - -### System.Collections.Generic.IEnumerable`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe] - -## NOTES - -## RELATED LINKS - -[Add a probe to an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#add-a-probe-to-an-existing-application-gateway) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 8bf9bb475d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Gets an existing redirect configuration from an Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayRedirectConfiguration [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayRedirectConfiguration** cmdlet gets an existing redirect configuration from an Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $RedirectConfig = Get-AzureRmApplicationGatewayRedirectConfiguration -Name "Redirect01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the redirect configuration named Redirect01 from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -The name of the request routing rule - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration -System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration, Microsoft.Azure.Commands.Network, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index e341db3b98..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 57A6DB40-43EC-402C-9784-06817ECD99B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Gets the request routing rule of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayRequestRoutingRule [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayRequestRoutingRule** cmdlet gets the request routing rule of an application gateway. - -## EXAMPLES - -### Example 1: Get a specific request routing rule -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Rule = Get-AzureRmApplicationGatewayRequestRoutingRule -"Rule01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the request routing rule named Rule01 from the Application Gateway stored in the variable named $AppGW. - -### Example 2: Get a list of request routing rules -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Rules = Get-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets a list of request routing rules from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains request routing rule. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the request routing rule which this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySku.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySku.md deleted file mode 100644 index b9c8822663..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F01CB88A-49E7-41D8-B4E7-F1A4DCDC6B84 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysku -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewaySku - -## SYNOPSIS -Gets the SKU of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySku** cmdlet gets the stock keeping unit (SKU) of an application gateway. - -## EXAMPLES - -### Example 1: Get an application gateway SKU -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $SKU = Get-AzureRmApplicationGatewaySku -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the SKU of an application gateway named ApplicationGateway01 and stores the result in the variable named $SKU. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - -[Set-AzureRmApplicationGatewaySku](./Set-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslCertificate.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 090191bcc4..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 919B3755-81D4-43FB-AE8C-B071329A61D9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslcertificate -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Gets an SSL certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslCertificate [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslCertificate** cmdlet gets an SSL certificate for an application gateway. - -## EXAMPLES - -### Example 1: Get a specific SSL certificate -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Cert = Get-AzureRmApplicationGatewaySslCertificate -Name "Cert01" -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the SSL certificate named Cert01 from the application gateway stored in the variable named $AppGW. -The command stores the certificate in the variable named $Cert. - -### Example 2: Get a list of SSL certificates -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Certs = Get-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -This second command gets a list of SSL certificates from the application gateway stored in the variable named $AppGW. -The command then stores the results in the variable named $Certs. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object that contains the SSL certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of SSL certificate pool that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPolicy.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 5c1f8e9068..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AF02FFF8-F00D-4446-968F-F3C9008C39F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslpolicy -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Gets the SSL policy of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslPolicy** cmdlet gets the SSL policy of an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $sslpolicy = Get-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $AppGW -``` - -The first command gets the Application Gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. -The second command gets the ssl policy from the Application Gateway stored in the variable named $AppGW. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway of the SSL policy that this cmdlet gets. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md deleted file mode 100644 index 336a8ada75..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewaySslPredefinedPolicy.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaysslpredefinedpolicy -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewaySslPredefinedPolicy - -## SYNOPSIS -Gets Predefined SSL Policies provided by Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewaySslPredefinedPolicy [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewaySslPredefinedPolicy** cmdlet gets Predefined SSL Policies provided by Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$policies = Get-AzureRmApplicationGatewaySslPredefinedPolicy -``` - -This commands returns all the predefined SSL policies. - -### Example 2 -``` -PS C:\>$policy = Get-AzureRmApplicationGatewaySslPredefinedPolicy -Name AppGwSslPolicy20170401 -``` - -This commands returns predefined policy with name AppGwSslPolicy20170401. - -## 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 -Name of the ssl predefined policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPredefinedPolicy -System.Collections.Generic.IEnumerable`1[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPredefinedPolicy, Microsoft.Azure.Commands.Network, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index a2ae1adddc..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 000B32E9-FFFB-4165-87ED-F19A6E6CEE54 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Gets an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayUrlPathMapConfig [-Name <String>] -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayURLPathMapConfig** cmdlet gets an array of URL path mappings to a backend server pool. - -## EXAMPLES - -### Example 1: Get a URL path map configuration -``` -PS C:\>Get-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway Gateway -``` - -This command gets the URL path map configurations from the backend server located on the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet gets a URL path map configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the URL path map name in which this cmdlet get the path map configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap - -### System.Collections.Generic.IEnumerable`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap] - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index 6995d58e00..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D887302-7678-44C0-86F3-CEF2EF8A0991 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 ---- - -# Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Gets the WAF configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet gets the web application firewall (WAF) configuration of an application gateway. - -## EXAMPLES - -### Example 1: Get an application gateway web application firewall configuration -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $FirewallConfig = Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGW -``` - -The first command gets the application gateway named ApplicationGateway01, and then stores it in the $AppGW variable. - -The second command gets the firewall configuration of the application gateway in $AppGW, and then stores it in $FirewallConfig. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object. -You can use the Get-AzureRmApplicationGateway cmdlet to get an application gateway object. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index 0888ddaa16..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermapplicationsecuritygroup -schema: 2.0.0 ---- - -# Get-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Gets an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmApplicationSecurityGroup [-ResourceGroupName <String>] [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmApplicationSecurityGroup** cmdlet gets an application security group. - -## EXAMPLES - -### Example 1: Retrieve all application security groups. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -``` - -The command above returns the all application security groups in the subscription. - -### Example 2: Retrieve application security groups in a resource group. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -``` - -The command above returns all application security groups that belong to the resource group MyResourceGroup. - -### Example 3: Retrieve a specific application security group. -``` -PS C:\> Get-AzureRmApplicationSecurityGroup -ResourceGroupName MyResourceGroup -Name MyApplicationSecurityGroup -``` - -The command above returns the application security group MyApplicationSecurityGroup under the resource group MyResourceGroup. - -## 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 resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationSecurityGroup](./New-AzureRmApplicationSecurityGroup.md) - -[Remove-AzureRmApplicationSecurityGroup](./Remove-AzureRmApplicationSecurityGroup.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmBgpServiceCommunity.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmBgpServiceCommunity.md deleted file mode 100644 index 03e107c2c1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmBgpServiceCommunity.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermbgpservicecommunity -schema: 2.0.0 ---- - -# Get-AzureRmBgpServiceCommunity - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmBgpServiceCommunity [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description 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 -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBgpServiceCommunity - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md deleted file mode 100644 index e283d40520..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveNetworkSecurityGroup.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B9409AD6-F761-4B80-8E08-DBB2356F567D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermeffectivenetworksecuritygroup -schema: 2.0.0 ---- - -# Get-AzureRmEffectiveNetworkSecurityGroup - -## SYNOPSIS -Gets the effective network security group of a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEffectiveNetworkSecurityGroup -NetworkInterfaceName <String> [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmEffectiveNetworkSecurityGroup** cmdlet returns the effective network security group that is applied on a network interface. - -## EXAMPLES - -### Example 1: Get the effective network security group on a network interface -``` -PS C:\>Get-AzureRmEffectiveNetworkSecurityGroup -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "myResourceGroup" -``` - -This command gets all of the effective network security rules associated with the network interface named MyNetworkInterface in the resource group named myResourceGroup. - -## 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 -``` - -### -NetworkInterfaceName -Specified the name of a network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of a network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSEffectiveNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmEffectiveRouteTable](./Get-AzureRmEffectiveRouteTable.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveRouteTable.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveRouteTable.md deleted file mode 100644 index a7e2c07d53..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmEffectiveRouteTable.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 84FDB0F7-E6DE-4E1B-BD71-89535EDC6AA1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermeffectiveroutetable -schema: 2.0.0 ---- - -# Get-AzureRmEffectiveRouteTable - -## SYNOPSIS -Gets the effective route table of a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmEffectiveRouteTable -NetworkInterfaceName <String> [-ResourceGroupName <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmEffectiveRouteTable** cmdlet returns the effective route table that is applied on a network interface. - -## EXAMPLES - -### Example 1: Get the effective route table on a network interface -``` -PS C:\>Get-AzureRmEffectiveRouteTable -NetworkInterfaceName "MyNetworkInterface" -ResourceGroupName "MyResourceGroup" -``` - -This command gets the effective route table associated with network interface named MyNetworkInterface in the resource group named MyResourceGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -Specified the name of a network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group of a network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSEffectiveRoute - -## NOTES - -## RELATED LINKS - -[Get-AzureRmEffectiveNetworkSecurityGroup](./Get-AzureRmEffectiveNetworkSecurityGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuit.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuit.md deleted file mode 100644 index 13ec2602c1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C9954E3D-8645-473E-A6D4-86278C2F6BC1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuit -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuit - -## SYNOPSIS -Gets an Azure ExpressRoute circuit from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuit [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuit** cmdlet is used to retrieve an ExpressRoute circuit object -from your subscription. The circuit object returned can be used as input to other cmdlets that -operate on ExpressRoute circuits. - -## EXAMPLES - -### Example 1: Get the ExpressRoute circuit to be deleted -``` -Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzureRmExpressRouteCircuit -``` - -## 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 name of the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group that contains the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitARPTable.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitARPTable.md deleted file mode 100644 index 428862e3fb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitARPTable.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F0370845-13D9-4FB5-B30E-826A22EBC5E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitarptable -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitARPTable - -## SYNOPSIS -Gets the ARP table from an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitARPTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitARPTable** cmdlet retrieves the ARP table from both interfaces -of an ExpressRoute circuit. The ARP table provides a mapping of the IPv4 address to MAC address for -a particular peering. You can use the ARP table to validate layer 2 configuration and connectivity. - -## EXAMPLES - -### Example 1: Display the ARP table for an ExpressRoute peer -``` -Get-AzureRmExpressRouteCircuitARPTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType MicrosoftPeering -DevicePath Primary -``` - -## 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 -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitArpTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index 813023c082..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3D80F94B-AF9D-40C2-BE7E-2F32E5E926D2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitauthorization -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Gets information about ExpressRoute circuit authorizations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitAuthorization** cmdlet gets information about the -authorizations assigned to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises -network to the Microsoft cloud by using a connectivity provider instead of the public Internet. The -owner of an ExpressRoute circuit can create as many as 10 authorizations for each circuit; these -authorizations generate an authorization key that can be used by a virtual network owner to connect -his or her network to the circuit (one authorization per virtual network). Authorization keys, as -well as other information about the authorization, can be viewed at any time by running -**Get-AzureRmExpressRouteCircuitAuthorization**. - -## EXAMPLES - -### Example 1: Get all ExpressRoute authorizations -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit -``` - -These commands return information about all the ExpressRoute authorizations associated with an -ExpressRoute circuit. The first command uses the **Get-AzureRmExpressRouteCircuit** cmdlet to -create an object reference a circuit named ContosoCircuit; that object reference is stored in the -variable $Circuit. The second command then uses that object reference and the -**Get-AzureRmExpressRouteCircuitAuthorization** cmdlet to return information about the -authorizations associated with ContosoCircuit. - -### Example 2: Get all ExpressRoute authorizations using the Where-Object cmdlet -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" - Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit | Where-Object {$_.AuthorizationUseStatus -eq "Available"} -``` - -These commands represent a variation on the commands used in Example 1. In this case, however, -information is returned only for those authorizations that are available for use (that is, for -authorizations that have not been assigned to a virtual network). To do this, the circuit -authorization information is returned in command 2 and is piped to the **Where-Object** cmdlet. -**Where-Object** then picks out only those authorizations where the *AuthorizationUseStatus* -property is set to Available. To list only those authorizations that are not available, use this -syntax for the Where clause: - -`{$_.AuthorizationUseStatus -ne "Available"}` - -## 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 -``` - -### -ExpressRouteCircuit -Specifies the ExpressRoute circuit authorization. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the ExpressRoute circuit authorization that this cmdlet gets. - --Name "ContosoCircuitAuthorization" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -**Get-AzureRmExpressRouteCircuitAuthorization** accepts pipelined instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object. - -## OUTPUTS - -### PSExpressRouteCircuitAuthorization -**Get-AzureRmExpressRouteCircuitAuthorization** returns instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index 37ede2cf31..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 47C45467-F368-4993-937E-E7E975F400B5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Gets an ExpressRoute circuit peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitPeeringConfig** cmdlet retrieves the configuration of a peering -relationship for an ExpressRoute circuit. - -## EXAMPLES - -### Example 1: Display the peering configuration for an ExpressRoute circuit -``` -$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG -Get-AzureRmExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt -``` - -## 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 -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit object containing the peering configuration. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTable.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTable.md deleted file mode 100644 index 38ab5d83a7..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTable.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: BA7F6BAC-6047-42B0-B8CA-0B36302951B0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitroutetable -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitRouteTable - -## SYNOPSIS -Gets a route table from an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitRouteTable -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitRouteTable** cmdlet retrieves a detailed route table of an -ExpressRoute circuit. The route table will show all routes or can be filtered to show routes for a -specific peering type. You can use the route table to validate your peering configuration and -connectivity. - -## EXAMPLES - -### Example 1: Display the route table for the primary path -``` -Get-AzureRmExpressRouteCircuitRouteTable -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary' -``` - -## 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 -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md deleted file mode 100644 index 2d9d176f72..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitRouteTableSummary.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C603E0E-A19F-4EA6-B918-945007BE22FF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitroutetablesummary -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitRouteTableSummary - -## SYNOPSIS -Gets a route table summary of an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitRouteTableSummary -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] -DevicePath <DevicePathEnum> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitRouteTableSummary** cmdlet retrieves a summary of BGP neighbor -information for a particular routing context. This information is useful to determine for how long -a routing context has been established and the number of route prefixes advertised by the peering -router. - -## EXAMPLES - -### Example 1: Display the route summary for the primary path -``` -Get-AzureRmExpressRouteCircuitRouteTableSummary -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary' -``` - -## 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 -``` - -### -DevicePath -The acceptable values for this parameter are: `Primary` or `Secondary` - -```yaml -Type: DevicePathEnum -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitRoutesTableSummary - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitStats.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitStats.md deleted file mode 100644 index eec7df813d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteCircuitStats.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CFE184E2-6DEF-4E92-A9C3-E82F29BB4FB8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressroutecircuitstats -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteCircuitStats - -## SYNOPSIS -Gets usage statistics of an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteCircuitStats -ResourceGroupName <String> -ExpressRouteCircuitName <String> - [-PeeringType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteCircuitStats** cmdlet retrieves traffic statistics for an ExpressRoute -circuit. The statistics include the number of bytes sent and received over both the primary and -secondary routes. - -## EXAMPLES - -### Example 1: Display the traffic statistics for an ExpressRoute peer -``` -Get-AzureRmExpressRouteCircuitStats -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -PeeringType 'AzurePrivatePeering' -``` - -## 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 -``` - -### -ExpressRouteCircuitName -The name of the ExpressRoute circuit being examined. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group containing the ExpressRoute circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitStats - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteServiceProvider.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteServiceProvider.md deleted file mode 100644 index 2051841f5a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmExpressRouteServiceProvider.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 009F6E65-0268-4505-AEC1-FF379CB96804 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermexpressrouteserviceprovider -schema: 2.0.0 ---- - -# Get-AzureRmExpressRouteServiceProvider - -## SYNOPSIS -Gets a list ExpressRoute service providers and their attributes. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmExpressRouteServiceProvider [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmExpressRouteServiceProvider** cmdlet retrieves a list ExpressRoute service -providers and their attributes. Attribute include location and bandwidth options. - -## EXAMPLES - -### Example 1: Get a list of service provider with locations in "Silicon Valley" -``` -Get-AzureRmExpressRouteServiceProvider | - Where-Object PeeringLocations -Contains "Silicon Valley" | - Select-Object 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 -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteServiceProvider - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuitARPTable](Get-AzureRmExpressRouteCircuitARPTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTable](Get-AzureRmExpressRouteCircuitRouteTable.md) - -[Get-AzureRmExpressRouteCircuitRouteTableSummary](Get-AzureRmExpressRouteCircuitRouteTableSummary.md) - -[Get-AzureRmExpressRouteCircuitStats](Get-AzureRmExpressRouteCircuitStats.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancer.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancer.md deleted file mode 100644 index 9684c34ffd..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancer.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 78F356F6-A621-4C27-B9CC-D103E74B3A33 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancer -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancer - -## SYNOPSIS -Gets a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmLoadBalancer [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmLoadBalancer -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancer** cmdlet gets one or more Azure load balancers that are contained in a resource group. - -## EXAMPLES - -### Example 1: Get a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -This command gets the load balancer named MyLoadBalancer. -A load balancer must exist before you can run this cmdlet. - -## 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index f027c99e18..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F421174A-B138-45EB-AF84-CB3CE5870F27 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Gets a backend address pool configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerBackendAddressPoolConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet gets a single backend address pool or a list of backend address pools within a load balancer. - -## EXAMPLES - -### Example 1: Get the backend address pool -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" -LoadBalancer $loadbalancer -``` - -The first command gets an existing load balancer named MyLoadBalancer in the resource group named MyResourceGroup, and then stores it in the $loadbalancer variable. - -The second command gets the associated backend address pool configuration named BackendAddressPool02 for the load balancer in $loadbalancer. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the backend address pool to get. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that contains the backend address pool to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index e06c69b37e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6BEED413-E2E4-4557-BD31-2A655E790C1D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerfrontendipconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Gets a front-end IP configuration in a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerFrontendIpConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerFrontendIpConfig** cmdlet gets a front-end IP configuration or a list of front-end IP configurations in a load balancer. - -## EXAMPLES - -### Example 1: Get a front-end IP configuration in a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. - -The second command gets the front end IP configuration associated with that load balancer. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the front-end IP configuration to get. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that contains the front-end IP configuration to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 710ba9a53e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 614B0634-154A-449A-83E7-051DEF5A3BEE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerInboundNatPoolConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## 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 -``` - -### -LoadBalancer -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index 78eef2589e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1FDA90C0-D01F-45E1-9149-16AD04046271 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Gets an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerInboundNatRuleConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet gets one or more inbound network address translation (NAT) rules in an Azure load balancer. - -## EXAMPLES - -### Example 1: Get an inbound NAT rule configuration -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule1" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and stores it in the variable $slb. - -The second command gets the associated NAT rule named MyInboundNatRule1 from the load balancer in $slb. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the inbound NAT rule configuration to get. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index a634695814..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 278228EB-0126-4F27-A30F-51DC498C65FE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerprobeconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Gets a probe configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerProbeConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerProbeConfig** cmdlet gets one or more probe configurations for a load balancer. - -## EXAMPLES - -### Example 1: Get the probe configuration of a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. - -The second command gets the associated probe configuration named MyProbe from the load balancer in $slb. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the probe configuration to get. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSProbe - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index a92beff892..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B2CF11FC-520C-4C14-9A1B-13F06B250B5D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermloadbalancerruleconfig -schema: 2.0.0 ---- - -# Get-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Gets the rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLoadBalancerRuleConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLoadBalancerRuleConfig** cmdlet gets one or more rule configurations for a load balancer. - -## EXAMPLES - -### Example 1: Get the rule configuration of a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> Get-AzureRmLoadBalancerRuleConfig -Name "MyLBrulename" -LoadBalancer $slb -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the variable $slb. - -The second command gets the associated rule configuration named MyLBrulename from the load balancer in $slb. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that is associated with the rule configuration to get. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule configuration to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLocalNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLocalNetworkGateway.md deleted file mode 100644 index 033f29d9dd..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8756DA1-7BB9-4CD5-9D81-E11FF7A26125 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermlocalnetworkgateway -schema: 2.0.0 ---- - -# Get-AzureRmLocalNetworkGateway - -## SYNOPSIS -Gets a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLocalNetworkGateway [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. - -The **Get-AzureRmLocalNetworkGateway** cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Local Network Gateway -``` -Get-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -``` - -Returns the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG" - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterface.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterface.md deleted file mode 100644 index 5119fa9bbe..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterface.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E066BBFA-2E03-431D-85D1-99F230B6AC59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkinterface -schema: 2.0.0 ---- - -# Get-AzureRmNetworkInterface - -## SYNOPSIS -Gets a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpandStandAloneNic (Default) -``` -Get-AzureRmNetworkInterface [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandStandAloneNic -``` -Get-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NoExpandScaleSetNic -``` -Get-AzureRmNetworkInterface [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] - [-VirtualMachineIndex <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandScaleSetNic -``` -Get-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> - -VirtualMachineIndex <String> -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkInterface** cmdlet gets an Azure network interface or a list of Azure network interfaces in a resource group. - -## EXAMPLES - -### Example 1: Get all network interfaces -``` -PS C:\>Get-AzureRmNetworkInterface -``` - -This command gets all network interfaces for the current subscription. - -### Example 2: Get all network interfaces with a specific provisioning state -``` -PS C:\>Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" | Where-Object {$_.ProvisioningState -eq 'Succeeded'} -``` - -This command gets all network interfaces in the resource group named ResourceGroup1 that has a provisioning state of succeeded. - -## 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: NoExpandStandAloneNic, NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandStandAloneNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet gets network interfaces. - -```yaml -Type: String -Parameter Sets: NoExpandStandAloneNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandStandAloneNic, NoExpandScaleSetNic, ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineIndex -Specifies the virtual machine index of the virtual machine scale set from which this cmdlet gets network interfaces. - -```yaml -Type: String -Parameter Sets: NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetNic -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetName -Specifies the name of the virtual machine scale set from which this cmdlet gets network interfaces. - -```yaml -Type: String -Parameter Sets: NoExpandScaleSetNic -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetNic -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterfaceIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 39fbded3c5..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1B39809C-90DA-4ECB-B949-D4A9A54ED982 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkinterfaceipconfig -schema: 2.0.0 ---- - -# Get-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Gets a network interface IP configuration for a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkInterfaceIpConfig [-Name <String>] -NetworkInterface <PSNetworkInterface> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkInterfaceIPConfig** cmdlet gets a network interface IP configuration from an Azure network interface. - -## EXAMPLES - -### 1: Get an IP configuration of a network interface -``` -$nic1 = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName $myrg -Get-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -NetworkInterface $nic1 -``` - -The first command gets an existing network interface called mynic and stores it in the variable $nic1. The second - command gets the IP configuration called ipconfig1 of this network interface. - - -## 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 -Specifies the name of the network IP configuration that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object that contains the network IP configuration that this cmdlet gets. - -```yaml -Type: PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkInterface -Parameter 'NetworkInterface' accepts value of type 'PSNetworkInterface' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index e7a91945ba..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5AECCBD7-1FDE-4217-9F59-36328062E669 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworksecuritygroup -schema: 2.0.0 ---- - -# Get-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Gets a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmNetworkSecurityGroup [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkSecurityGroup** cmdlet gets an Azure network security group. - -## EXAMPLES - -### 1: Retrieve an existing network security group -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName "rg1" -``` - -This command returns contents of Azure network security group "nsg1" in resource group "rg1" - -## 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the network security group belongs to. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 24249c8ea1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5A0D9326-3A8A-4156-8372-EBA93C1BB4E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworksecurityruleconfig -schema: 2.0.0 ---- - -# Get-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Get a network security rule configuration for a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-DefaultRules] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmNetworkSecurityRuleConfig** cmdlet gets a network security rule configuration for an Azure network security group. - -## EXAMPLES - -### 1: Retrieving a network security rule config -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 - | Get-AzureRmNetworkSecurityRuleConfig -Name AllowInternetOutBound -DefaultRules -``` - -This command retrieves the default rule named "AllowInternetOutBound" from Azure network security group named "nsg1" in resource group "rg1" - -### 2: Retrieving a network security rule config using only the name -``` -Get-AzureRmNetworkSecurityGroup -Name nsg1 -ResourceGroupName rg1 - | Get-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -``` - -This command retrieves user defined rule named "rdp-rule" from Azure network security group named "nsg1" in resource group "rg1" - -## 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 -``` - -### -DefaultRules -Indicates whether this cmdlet gets a user-created rule configuration or a default rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object that contains the network security rule configuration to get. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkSecurityGroup -Parameter 'NetworkSecurityGroup' accepts value of type 'PSNetworkSecurityGroup' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSecurityRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkUsage.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkUsage.md deleted file mode 100644 index 12f413db5c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkUsage.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkusage -schema: 2.0.0 ---- - -# Get-AzureRmNetworkUsage - -## SYNOPSIS -Lists network usages for a subscription - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmNetworkUsage -Location <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkUsage cmdlet gets limits and current usage for Network resources. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmNetworkUsage -Location westcentralus - -ResourceType : Virtual Networks -CurrentValue : 6 -Limit : 50 - -ResourceType : Static Public IP Addresses -CurrentValue : 1 -Limit : 20 - -ResourceType : Network Security Groups -CurrentValue : 2 -Limit : 100 - -ResourceType : Public IP Addresses -CurrentValue : 6 -Limit : 60 - -ResourceType : Network Interfaces -CurrentValue : 1 -Limit : 300 - -ResourceType : Load Balancers -CurrentValue : 1 -Limit : 100 - -ResourceType : Application Gateways -CurrentValue : 1 -Limit : 50 - -ResourceType : Route Tables -CurrentValue : 0 -Limit : 100 - -ResourceType : Route Filters -CurrentValue : 0 -Limit : 1000 - -ResourceType : Network Watchers -CurrentValue : 1 -Limit : 1 - -ResourceType : Packet Captures -CurrentValue : 0 -Limit : 10 -``` - -Gets resources usage data in westcentralus region - -## 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 -The location where resource usage is queried. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSUsage - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcher.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcher.md deleted file mode 100644 index 5ff9324e64..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcher - -## SYNOPSIS -Gets the properties of a Network Watcher - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Get -``` -Get-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### List -``` -Get-AzureRmNetworkWatcher [-ResourceGroupName <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcher cmdlet gets one or more Azure Network Watcher resources. - -## EXAMPLES - -### -------------------------- Example 1: Get a Network Watcher -------------------------- -``` -Get-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG - -Name : NetworkWatcher_westcentralus -Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus -Etag : W/"ac624778-0214-49b9-a04c-794863485fa6" -Location : westcentralus -Tags : -ProvisioningState : Succeeded -``` - -Gets the Network Watcher named NetworkWatcher_westcentralus in the resource group NetworkWatcherRG. - -## 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 network watcher name. - -```yaml -Type: String -Parameter Sets: Get -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: List -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index ef86291efc..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Returns connection monitor with specified name or the list of connection monitors - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherConnectionMonitor cmdlet returns the connection monitor with the specified name / resourceId or the list of connection monitors corresponding to the specified network watcher / location. - -## EXAMPLES - -### --------------- Example 1: Get connection monitor by name in the specified location --------------- -``` -PS C:\> Get-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm - - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/cm -Etag : W/"40961b58-e379-4204-a47b-0c477739b095" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6 - a1f99/resourceGroups/VarunRgCentralUSEUAP/providers/Microsoft.C - ompute/virtualMachines/irinavm", - "Port": 0 - } -Destination : { - "Address": "google.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:19:28 PM -MonitoringStatus : Stopped -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : { - "key1": "value1" - } -``` - -In this example we get connection monitor by name in the specified location. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID of the connection monitor. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md deleted file mode 100644 index c40a169a19..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherConnectionMonitorReport.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcher -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherConnectionMonitorReport - -## SYNOPSIS -Query a snapshot of the most recent connection states. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -NetworkWatcher <PSNetworkWatcher> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByLocation -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -Location <String> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -ResourceId <String> [-Name <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] -``` - -### SetByInputObject -``` -Get-AzureRmNetworkWatcherConnectionMonitorReport -InputObject <PSConnectionMonitorResult> [-Name <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherConnectionMonitorReport cmdlet returns the report on the most recent connection states. - -## EXAMPLES - -### --------------- Example 1: Get the most recent connection snapshot of the connection monitor by name in the specified location --------------- -``` -PS C:\> Get-AzureRmNetworkWatcherConnectionMonitorReport -Location centraluseuap -Name cm - - -States : [ - { - "ConnectionState": "Reachable", - "StartTime": "2018-01-12T01:18:20Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "1530e0f2-c9b7-4bc0-a205-cf7332cd8983", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "b19b74b1-423d-4f0b-99cd-bcaed4d0b8a2", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "80e46c56-2cf9-4106-8602-608a74832d41" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "80e46c56-2cf9-4106-8602-608a74832d41", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "e17cf884-69db-43b8-9cd5-f920770a0dbe" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "e17cf884-69db-43b8-9cd5-f920770a0dbe", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - }, - { - "ConnectionState": "Unreachable", - "StartTime": "2018-01-12T01:14:11Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "b6251ff8-3d07-4fdf-98f8-04b168e1cf90", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "de6d463b-47fb-4beb-afc4-d77782755313" - ], - "Issues": [ - { - "Origin": "Local", - "Severity": "Error", - "Type": "NetworkError", - "Context": [] - } - ] - }, - { - "Type": "VirtualAppliance", - "Id": "de6d463b-47fb-4beb-afc4-d77782755313", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "0cbadb7e-cd99-4fa9-a832-eb4e0d112293" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "0cbadb7e-cd99-4fa9-a832-eb4e0d112293", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "538005d1-994a-4350-9866-6985385beecf" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "538005d1-994a-4350-9866-6985385beecf", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - }, - { - "ConnectionState": "Reachable", - "StartTime": "2018-01-11T23:54:05Z", - "EvaluationState": "Completed", - "Hops": [ - { - "Type": "Source", - "Id": "3dbec7e8-a37f-4acd-bc5f-86918fffba0e", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "1a87cf61-1be6-4add-bba7-f84afbcf3726" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "1a87cf61-1be6-4add-bba7-f84afbcf3726", - "Address": "10.1.2.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/fwNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "070c0740-308e-43ba-b72f-5d8d5a6537ec" - ], - "Issues": [] - }, - { - "Type": "VirtualAppliance", - "Id": "070c0740-308e-43ba-b72f-5d8d5a6537ec", - "Address": "10.1.3.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/auNic/ipConfigurations/ipconfig1", - "NextHopIds": [ - "760182e1-c88d-4cfc-a711-65e7e622a67a" - ], - "Issues": [] - }, - { - "Type": "VirtualNetwork", - "Id": "760182e1-c88d-4cfc-a711-65e7e622a67a", - "Address": "10.1.4.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/VarunRgCentralUSEUAP - /providers/Microsoft.Network/networkInterfaces/dbNic0/ipConfigurations/ipconfig1", - "NextHopIds": [], - "Issues": [] - } - ] - } - ] - -``` - -In this example we query the most recent connection states of the specified connection monitor. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID of the connection monitor. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorQueryResult - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md deleted file mode 100644 index 245b6176e0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherFlowLogStatus.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherflowlogstatus -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherFlowLogStatus - -## SYNOPSIS -Gets the status of flow logging on a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherFlowLogStatus cmdlet Gets the status of flow logging on a resource. -The status includes whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, and the retention policy for the logs. -Currently Network Security Groups are supported for flow logging. - -## EXAMPLES - -### --- Example 1: Get the Flow Logging Status for a Specified NSG --- -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG - -PS C:\> Get-AzureRmNetworkWatcherFlowLogStatus -NetworkWatcher $NW -TargetResourceId $nsg.Id - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -Properties : { - "Enabled": true, - "RetentionPolicy": { - "Days": 0, - "Enabled": false - }, - "StorageId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" - } -``` - -In this example we get the flow logging status for a Network Security Group. The specified NSG has flow logging enabled, and no retention policy set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFlowLog - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging - -## RELATED LINKS - -[Set-AzureRmNetworkWatcherConfigFlowLog](./Set-AzureRmNetworkWatcherConfigFlowLog.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherNextHop.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherNextHop.md deleted file mode 100644 index 6d63d21f97..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherNextHop.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchernexthop -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherNextHop - -## SYNOPSIS -Gets the next hop from a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherNextHop -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - -DestinationIPAddress <String> -SourceIPAddress <String> [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherNextHop -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> -DestinationIPAddress <String> -SourceIPAddress <String> - [-TargetNetworkInterfaceId <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherNextHop cmdlet gets the next hop from a VM. -Next hop allows you to view the type of Azure resource, the associated IP address of that resource, and the routing table rule that is responsible for the route. - -## EXAMPLES - -### -- Example 1: Get the Next Hop when communicating with an Internet IP -- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName ContosoResourceGroup -Name VM0 -$Nics = Get-AzureRmNetworkInterface | Where {$_.Id -eq $vm.NetworkInterfaceIDs.ForEach({$_})} -Get-AzureRmNetworkWatcherNextHop -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -SourceIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -DestinationIPAddress 204.79.197.200 - - -NextHopIpAddress NextHopType RouteTableId ----------------- ----------- ------------ - Internet System Route -``` - -Get's the Next Hop for outbound communication from the primary Network Interface on the specified Virtual Vachine to 204.79.197.200 (www.bing.com) - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationIPAddress -Destination IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceIPAddress -Source IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNetworkInterfaceId -Target network interface Id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNextHopResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherPacketCapture.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index c1c74648ae..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherpacketcapture -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Gets information and properties and status of a packet capture resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> [-PacketCaptureName <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - [-PacketCaptureName <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherPacketCapture gets the properties and status of a packet capture resource. - -## EXAMPLES - -### --- Example 1: Create a Packet Capture with multiple filters and retrieve its status --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filters $filter1, $filter2 - -Get-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. -We then call Get-AzureRmNetworkWatcherPacketCapture to retrieve the status of the capture session. - -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGetPacketCaptureResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md deleted file mode 100644 index 57cef4e4a0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherReachabilityProvidersList.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatcherreachabilityproviderslist -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherReachabilityProvidersList - -## SYNOPSIS -Lists all available internet service providers for a specified Azure region. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByName (Default) -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcherName <String> -ResourceGroupName <String> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcher <PSNetworkWatcher> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Get-AzureRmNetworkWatcherReachabilityProvidersList -ResourceId <String> - [-Location <System.Collections.Generic.List`1[System.String]>] [-Country <String>] [-State <String>] - [-City <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherReachabilityProvidersList lists all available internet service providers for a specified Azure region. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $nw = Get-AzureRmNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG -PS C:\> Get-AzureRmNetworkWatcherReachabilityProvidersList -NetworkWatcher $nw -Location "West US" -Country "United States" -State "washington" -City "seattle" - -"countries" : [ - { - "countryName" : "United States", - "states" : [ - { - "stateName" : "washington", - "cities" : [ - { - "cityName" : "seattle", - "providers" : [ - "Comcast Cable Communications, Inc. - ASN 7922", - "Comcast Cable Communications, LLC - ASN 7922", - "Level 3 Communications, Inc. (GBLX) - ASN 3549", - "Qwest Communications Company, LLC - ASN 209" - ] - } - ] - } - ] - } -] -``` - -Lists all available providers in Seattle, WA for Azure Data Center in West US. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The name of the city. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -The name of the country. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Optional Azure regions to scope the query to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: ResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -The Id of network watcher resource. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -The name of the state. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSAvailableProvidersList - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, next, hop - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md deleted file mode 100644 index 27eafbeffb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherSecurityGroupView.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchersecuritygroupview -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherSecurityGroupView - -## SYNOPSIS -View the configured and effective network security group rules applied on a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherSecurityGroupView enables you to view the configured and effective network security group rules applied on a VM. - -## EXAMPLES - -### --- Example 1: Make a Security Group View call on a VM --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName ContosoResourceGroup -Name VM0 -Get-AzureRmNetworkWatcherSecurityGroupView -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -``` - -In the above example, we first get the regional Network Watcher, then a VM in the region. -Then we make a Security Group View call on the specified VM. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target VM Id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSViewNsgRules - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTopology.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTopology.md deleted file mode 100644 index 7861bd22a1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTopology.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchertopology -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherTopology - -## SYNOPSIS -Gets a network level view of resources and their relationships in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherTopology -NetworkWatcher <PSNetworkWatcher> -TargetResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherTopology -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherTopology cmdlet a network level view of resources and their relationships in a resource group. -Note: If resources from multiple regions reside in the resource group, only the resources in the same region as the Network Watcher will be included in the JSON output. - -## EXAMPLES - -### -------------------------- Example 1: Get an Azure Topology -------------------------- -``` -$networkWatcher = Get-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -Get-AzureRmNetworkWatcherTopology -NetworkWatcher $networkWatcher -ResourceGroupName testresourcegroup - -Id : e33d80cf-4f76-4b8f-b51c-5bb8eba80103 -CreatedDateTime : 0/00/0000 9:21:51 PM -LastModified : 0/00/0000 4:53:29 AM -TopologyResources : [ - { - "Name": "testresourcegroup-vnet", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "default", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "default", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "Location": "westcentralus", - "TopologyAssociations": [] - }, - { - "Name": "VM0", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", - "TopologyAssociations": [ - { - "Name": "vm0131", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "vm0131", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "VM0", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Compute/virtualMachines/VM0", - "AssociationType": "Associated" - }, - { - "Name": "VM0-nsg", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", - "AssociationType": "Associated" - }, - { - "Name": "default", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/virtualNetworks/testresourcegroup-vnet/subnets/default", - "AssociationType": "Associated" - }, - { - "Name": "VM0-ip", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", - "AssociationType": "Associated" - } - ] - }, - { - "Name": "VM0-nsg", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "default-allow-rdp", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", - "AssociationType": "Contains" - } - ] - }, - { - "Name": "default-allow-rdp", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkSecurityGroups/VM0-nsg/securityRules/default-allow-rdp", - "Location": "westcentralus", - "TopologyAssociations": [] - }, - { - "Name": "VM0-ip", - "Id": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/publicIPAddresses/VM0-ip", - "Location": "westcentralus", - "TopologyAssociations": [ - { - "Name": "vm0131", - "ResourceId": "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/testresourcegroup/providers/Microsoft.Network/networkInterfaces/vm0131", - "AssociationType": "Associated" - } - ] - } - ] -``` - -In this example we run the Get-AzureRmNetworkWatcherTopology cmdlet on a resource group that contains a VM, Nic, NSG, and public IP. - -## 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 -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSTopology - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, topology, view - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md deleted file mode 100644 index b8ac48fda9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmNetworkWatcherTroubleshootingResult.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermnetworkwatchertroubleshootingresult -schema: 2.0.0 ---- - -# Get-AzureRmNetworkWatcherTroubleshootingResult - -## SYNOPSIS -Gets the troubleshooting result from the previously run or currently running troubleshooting operation. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmNetworkWatcherTroubleshootingResult cmdlet gets the troubleshooting result from the previously run or currently running Start-AzureRmNetworkWatcherResourceTroubleshooting operation. -If the troubleshooting operation is currently in progress, then this operation may take a few minutes to complete. Currently Virtual Network Gateways and Connections are supported. - -## EXAMPLES - -### --- Example 1: Start Troubleshooting on a Virtual Network Gateway and Retrieve Result --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' -$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' -$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' - -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath - -Get-AzureRmNetworkWatcherTroubleshootingResult -NetworkWatcher $NW -TargetResourceId $target -``` - -The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. -After troubleshooting has started, a Get-AzureRmNetworkWatcherTroubleshootingResult call is made to the resource to retrieve the result of this call. - -## 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 -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSViewNsgRules - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection - -## RELATED LINKS - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmPublicIpAddress.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmPublicIpAddress.md deleted file mode 100644 index 03b01448a5..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0CD03BF8-8DB6-44BC-91F0-D863949DBD17 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermpublicipaddress -schema: 2.0.0 ---- - -# Get-AzureRmPublicIpAddress - -## SYNOPSIS -Gets a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpandStandAloneIp (Default) -``` -Get-AzureRmPublicIpAddress [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandStandAloneIp -``` -Get-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NoExpandScaleSetIp -``` -Get-AzureRmPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-VirtualMachineScaleSetName <String>] - [-VirtualMachineIndex <String>] [-NetworkInterfaceName <String>] [-IpConfigurationName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ExpandScaleSetIp -``` -Get-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> -VirtualMachineScaleSetName <String> - -VirtualMachineIndex <String> -NetworkInterfaceName <String> -IpConfigurationName <String> - -ExpandResource <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPublicIPAddress** cmdlet gets one or more public IP addresses in a resource group. - -## EXAMPLES - -### 1: Get a public IP resource -``` -$publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName $publicIp -``` - -This command gets a public IP address resource with name $publicIPName in the resource group $rgName. - -## 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurationName -Network Interface IP Configuration Name. -```yaml -Type: String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the public IP address that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: NoExpandStandAloneIp, NoExpandScaleSetIp -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandStandAloneIp, ExpandScaleSetIp -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkInterfaceName -Virtual Machine Network Interface Name. -```yaml -Type: String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the public IP address that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: NoExpandStandAloneIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandStandAloneIp, NoExpandScaleSetIp, ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineIndex -Virtual Machine Index. -```yaml -Type: String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachineScaleSetName -Virtual Machine Scale Set Name. -```yaml -Type: String -Parameter Sets: NoExpandScaleSetIp -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ExpandScaleSetIp -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteConfig.md deleted file mode 100644 index 73f33336c0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteConfig.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DBD40431-DD7A-42CB-83AA-568B1065A468 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermrouteconfig -schema: 2.0.0 ---- - -# Get-AzureRmRouteConfig - -## SYNOPSIS -Gets routes from a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRouteConfig** cmdlet gets routes from an Azure route table. -You can specify a route by name. - -## EXAMPLES - -### Example 1: Get a route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Get-AzureRmRouteConfig -Name "Route07" -Name : route07 -Id : -Etag : -ProvisioningState : -AddressPrefix : 10.1.0.0/16 -NextHopType : VnetLocal -NextHopIpAddress : -``` - -This command gets the route table named RouteTable01 by using the **Get-AzureRmRouteTable** cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet gets the route named Route07 in the route table named RouteTable01. - -## 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 -Specifies the name of the route that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table from which this cmdlet gets routes. - -```yaml -Type: PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteTable -Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRoute - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilter.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilter.md deleted file mode 100644 index 0050ff0b1f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilter.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutefilter -schema: 2.0.0 ---- - -# Get-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmRouteFilter [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description 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 -``` - -### -ExpandResource -The resource reference to be expanded. - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilterRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index 1c32db26f4..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutefilterruleconfig -schema: 2.0.0 ---- - -# Get-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmRouteFilterRuleConfig [-Name <String>] -RouteFilter <PSRouteFilter> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description 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 -``` - -### -Name -The name of the route filter rule - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteTable.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteTable.md deleted file mode 100644 index d128675053..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmRouteTable.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4F487FCA-930D-4D56-8D28-7693312E1A01 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermroutetable -schema: 2.0.0 ---- - -# Get-AzureRmRouteTable - -## SYNOPSIS -Gets route tables. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Expand -``` -Get-AzureRmRouteTable -ResourceGroupName <String> -Name <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### NoExpand -``` -Get-AzureRmRouteTable [-ResourceGroupName <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmRouteTable** cmdlet gets Azure route tables. -You can get a single route table, or get all the route tables in a resource group or in your subscription. - -## EXAMPLES - -### Example 1: Get a route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/routetable01 -Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 in the resource group named 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route table that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the route tables that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetwork.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetwork.md deleted file mode 100644 index ce2ac6ee0e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CBDF4BCB-7EB3-4D64-B19C-1314D4AB84E4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetwork -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetwork - -## SYNOPSIS -Gets a virtual network in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NoExpand -``` -Get-AzureRmVirtualNetwork [-Name <String>] [-ResourceGroupName <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### Expand -``` -Get-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> -ExpandResource <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetwork** cmdlet gets one or more virtual networks n a resource group. - -## EXAMPLES - -### 1: Retrieve a virtual network -``` -Get-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -``` - -This command gets the virtual network named MyVirtualNetwork in the resource group TestResourceGroup - -## 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 -``` - -### -ExpandResource -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that virtual network belongs to. - -```yaml -Type: String -Parameter Sets: NoExpand -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: Expand -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md deleted file mode 100644 index c61b4db1a6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkAvailableEndpointService.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkavailableendpointservice -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkAvailableEndpointService - -## SYNOPSIS -Lists available endpoint services for location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkAvailableEndpointService -Location <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Get-AzureRmVirtualNetworkAvailableEndpointService lists endpoint services available in the specified location. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkAvailableEndpointService -Location westus - --Name Id Type ------ -- ---- --Microsoft.Storage /subscriptions/id/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage Microsoft.Network/virtualNetworkEndpointServices -``` - -Gets available endpoint services in westus region. - -## 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 -The location to retrieve the endpoint services from. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Network.Models.PSEndpointServiceResult, Microsoft.Azure.Commands.Network, Version=4.2.1.0, Culture=neutral, PublicKeyToken=null]] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 74a3675821..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9CBF592E-734B-4A0C-A45D-358C226D08C7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Gets a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGateway [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. - -The **Get-AzureRmVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Virtual Network Gateway -``` -Get-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG -``` - -Returns the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md deleted file mode 100644 index 73efaae63c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayAdvertisedRoute.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayadvertisedroute -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayAdvertisedRoute - -## SYNOPSIS -Lists routes being advertised by an Azure virtual network gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - -Peer <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Given the IP of a BGP peer, enumerates routes being advertised to that peer by the specified Azure virtual network gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer 10.0.0.254 -``` - -For the Azure gateway named gatewayName in resource group resourceGroupName, retrives a list of routes being advertised to the BGP peer with IP 10.0.0.254 - -### Example 2 -``` -PS C:\> $bgpPeerStatus = Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -PS C:\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer $bgpPeerStatus[0].Neighbor -``` - -For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves routes being advertised to the first BGP peer on the gateway's list of BGP peers. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Peer -BGP peer's IP address. This should be an IP within the address space accessible from within the Azure virtual network the gateway is deployed in. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute[] - -## NOTES -This command is only applicable to Azure virtual network gateways with BGP enabled connections. - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md deleted file mode 100644 index 5ef67bb3ff..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayBGPPeerStatus.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaybgppeerstatus -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayBGPPeerStatus - -## SYNOPSIS -Lists an Azure virtual network gateway's BGP peers - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - [-Peer <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This command enumerates BGP peers an Azure virtual network gateway is configured to peer with. The status of each peer is also given. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayBgpPeerStatus -ResourceGroupName resourceGroup -VirtualNetworkGatewayName gatewayName - -Asn : 65515 -ConnectedDuration : 9.01:04:53.5768637 -LocalAddress : 10.1.0.254 -MessagesReceived : 14893 -MessagesSent : 14900 -Neighbor : 10.0.0.254 -RoutesReceived : 1 -State : Connected -``` - -Retrieves BGP peers for the Azure virtual network gateway named gatewayName in resource group resourceGroup. - -This example output shows one connected BGP peer, with an IP of 10.0.0.254. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Peer -IP of the peer to retrieve status for - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBGPPeerStatus[] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index d59a453c40..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 617FB2F9-05EA-4224-B9A9-2F00A7599486 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Gets a Virtual Network Gateway Connection - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnection [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. - -The **Get-AzureRmVirtualNetworkGatewayConnection** cmdlet returns the object of your connection based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Get a Virtual Network Gateway Connection -``` -Get-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG -``` - -Returns the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index 31f8de3895..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: ECC5C079-C9A0-4159-A039-EE216897D686 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnectionSharedKey [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md deleted file mode 100644 index 0009cfa7f7..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewayconnectionvpndeviceconfigscript -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript - -## SYNOPSIS -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -Name <String> -ResourceGroupName <String> - -DeviceVendor <String> -DeviceFamily <String> -FirmwareVersion <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -This commandlet takes the connection resource, VPN device brand, model, firmware version, and return the corresponding configuration script that customers can apply directly on their on-premises VPN devices. The script will follow the syntax of the selected device, and fill in the necessary parameters such as Azure gateway public IP addresses, virtual network address prefixes, VPN tunnel pre-shared key, etc. so customers can simply copy-paste to their VPN device configurations. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway -PS C:\> Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript -ResourceGroupName TestRG -Name TestConnection -DeviceVendor "Cisco-Test" -DeviceFamily "IOS-Test" -FirmwareVersion "20" -``` - -The above example uses Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice to get the supported VPN Device brands, models, and firmware versions. -Then uses one of the returned models information to generate a VPN Device configuration script for the VirtualNetworkGatewayConnection "TestConnection". The device used in this example has DeviceFamily "IOS-Test", DeviceVendor "Cisco-Test" and FirmwareVersion 20. - -## 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 -``` - -### -DeviceFamily -Name of the VPN device model/family. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DeviceVendor -Name of the VPN device vendor. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirmwareVersion -Firmware version of the VPN device. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The resource name of the connection for which the configuration is to be generated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md deleted file mode 100644 index 9ac2fc669f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewayLearnedRoute.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaylearnedroute -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewayLearnedRoute - -## SYNOPSIS -Lists routes learned by an Azure virtual network gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewayLearnedRoute -VirtualNetworkGatewayName <String> -ResourceGroupName <String> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Enumerates routes learned by an Azure virtual network gateway from various sources. This includes routes learned over BGP, as well as static routes. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkGatewayLearnedRoute -ResourceGroupName resourceGroup -VirtualNetworkGatewayname gatewayName - -AsPath : -LocalAddress : 10.1.0.254 -Network : 10.1.0.0/16 -NextHop : -Origin : Network -SourcePeer : 10.1.0.254 -Weight : 32768 - -AsPath : -LocalAddress : 10.1.0.254 -Network : 10.0.0.254/32 -NextHop : -Origin : Network -SourcePeer : 10.1.0.254 -Weight : 32768 - -AsPath : 65515 -LocalAddress : 10.1.0.254 -Network : 10.0.0.0/16 -NextHop : 10.0.0.254 -Origin : EBgp -SourcePeer : 10.0.0.254 -Weight : 32768 -``` - -For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves routes the Azure gateway knows. - -The Azure virtual network gateway in this case has two static routes (10.1.0.0/16 and 10.0.0.254/32), as well as one route learned over BGP (10.0.0.0/16). - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Virtual network gateway resource group's name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Virtual network gateway name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSGatewayRoute[] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md deleted file mode 100644 index 104ec37cc3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkgatewaysupportedvpndevice -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice - -## SYNOPSIS -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -Name <String> -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -This commandlet returns a list of supported VPN device brands, models, and firmware versions. - -## EXAMPLES - -### Example 1 - -Returns list of supported VPN device brands, models and firmware versions: - -```powershell -Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice -ResourceGroupName TestRG -Name TestGateway -``` - -```Output -<?xml version="1.0" encoding="utf-8"?> -<RpVpnDeviceList version="1.0"> - <Vendor name="Cisco-Test"> - <DeviceFamily name="IOS-Test"> - <FirmwareVersion name="20" /> - </DeviceFamily> - </Vendor> -</RpVpnDeviceList> -``` - -## 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 virtual network gateway name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkPeering.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index 5903a117a1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 463DDBA8-0F93-483D-A4B6-3B055968CDE8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkpeering -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Gets the virtual network peering. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkPeering -VirtualNetworkName <String> -ResourceGroupName <String> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkPeering** cmdlet gets the virtual network peering. - -## EXAMPLES - -### Example 1: Get a peering between two virtual networks -``` -# Get virtual network peering named myVnet1TomyVnet2 located in myVirtualNetwork in the resource group named myResourceGroup. - -Get-AzureRmVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetwork "myVnet" -ResourceGroupName "myResourceGroup" -``` - -## 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 -Specifies the virtual network peering name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name that the virtual network peering belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -Specifies the virtual network name that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkPeering](./Add-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - -[Set-AzureRmVirtualNetworkPeering](./Set-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index 26ef75e4e0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7688CE56-0A25-4409-9676-BF1B67C3F05F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworksubnetconfig -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Gets a subnet in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet gets one or more subnet configurations in an Azure virtual network. - -## EXAMPLES - -### 1: Get a subnet in a virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - $virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - Get-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -``` - -This example creates a resource group and a virtual network with a single subnet in that resource group. It then retrieves data about that 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 -``` - -### -Name -Specifies the name of the subnet configuration that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration that this cmdlet gets. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkUsageList.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkUsageList.md deleted file mode 100644 index c092107e92..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVirtualNetworkUsageList.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvirtualnetworkusagelist -schema: 2.0.0 ---- - -# Get-AzureRmVirtualNetworkUsageList - -## SYNOPSIS -Gets virtual network current usage. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVirtualNetworkUsageList -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVirtualNetworkUsageList** cmdlet gets per subnet usage for the specified virtual network. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest - -Get-AzureRmVirtualNetworkUsageList -ResourceGroupName test -Name usagetest - -Name : Subnet size and usage -Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet -CurrentValue : 1 -Limit : 65531 -Unit : Count - -Name : Subnet size and usage -Id : /subscriptions/sub1/resourceGroups/test/providers/Microsoft.Network/virtualNetworks/usagetest/subnets/subnet11 -CurrentValue : 0 -Limit : 251 -Unit : Count -``` - -Gets per subnet current values of usage for usagetest virtual network. - -## 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 -Specifies the name of the virtual network to show usages for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that virtual network belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkUsage - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientConfiguration.md deleted file mode 100644 index df7a67bd35..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientConfiguration.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientconfiguration -schema: 2.0.0 ---- - -# Get-AzureRmVpnClientConfiguration - -## SYNOPSIS -Allows users to easily download the Vpn Profile package that was generated using the New-AzureRmVpnClientConfiguration commandlet. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmVpnClientConfiguration -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -AuthenticationMethod "EAPTLS" -RadiusRootCert "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" - -PS C:\> Get-AzureRmVpnClientConfiguration -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -``` - -Gets the URL to download a VpnClient profile that has been previously generated using the New-AzureRMVpnClientConfiguration command. - -## 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 resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnProfile - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientPackage.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientPackage.md deleted file mode 100644 index c03b76ad0c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientPackage.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2B4A3E2A-1868-492F-9F77-932319D2CE6D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientpackage -schema: 2.0.0 ---- - -# Get-AzureRmVpnClientPackage - -## SYNOPSIS -Gets information about a VPN client package. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientPackage -ResourceGroupName <String> -VirtualNetworkGatewayName <String> - -ProcessorArchitecture <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientPackage** cmdlet gets information about the VPN client packages available from a virtual network gateway. -Client packages contain configuration data that enable a client computer to make a VPN connection to an Azure virtual network; client computers must have the correct configuration package installed in order to make a VPN connection. -Different configuration packages are available based on the client computer's version of Windows (for example, Windows 7 or Windows 10) and on the client computer's processor architecture (AMD64 or x86). -You must specify the architecture type when running **Get-AzureRmVpnClientPackage**. - -## EXAMPLES - -### Example 1: Get information about a processor architecture VPN client package -``` -PS C:\>Get-AzureRmVpnClientPackage -ProcessorArchitecture -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -ProcessorArchitecture "Amd64" -``` - -This command gets information about the AMD64 VPN client packages stored on the virtual network gateway named ContosoVirtualNetworkGateway. -To get information about the x86 client packages, set the value of the *ProcessorArchitecture* parameter to x86. - -## 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 -``` - -### -ProcessorArchitecture -Specifies the type of CPU architecture that the client package is designed for. -Valid values are Amd64 and X86. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Amd64, X86 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the client package information is stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -Parameter 'ResourceGroupName' accepts value of type 'String' from the pipeline - -### String -Parameter 'VirtualNetworkGatewayName' accepts value of type 'String' from the pipeline - -## OUTPUTS - -### -**Get-AzureRmVpnClientPackage** returns instances of the System.String object. - -## NOTES - -## RELATED LINKS - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayVpnClientConfig](./Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRevokedCertificate.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index e2dbc30840..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 05626BF7-F886-4C76-8FC2-DDF783DEB539 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientrevokedcertificate -schema: 2.0.0 ---- - -# Get-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Gets information about VPN client-revocation certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientRevokedCertificate [-VpnClientRevokedCertificateName <String>] - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientRevokedCertificate** cmdlet returns information about the client-revocation certificates assigned to a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -**Get-AzureRmVpnClientRevokedCertificate** enables you to return information about all the client-revocation certificates on the gateway or, by using the *VpnClientRevokedCertificateName* parameter, to get information about a single certificate. - -## EXAMPLES - -### Example 1: Get information about all client-revocation certificates -``` -PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -``` - -This command gets information about all the client-revocation certificates associated with the virtual network gateway named ContosoVirtualNetworkGateway. - -### Example 2: Get information about specific client-revocation certificates -``` -PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate" -``` - -This command is a variation of the command shown in Example 1. -In this case, however, the *VpnClientRevokedCertificateName* parameter is used to limit the returned data to a specific client-revoked certificate: the certificate with the name ContosoRevokedClientCertificate. - -## 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 the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the revoked certificate information is assigned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### -**Get-AzureRmVpnClientRevokedCertificate** returns instances of the **Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRootCertificate.md b/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index 684aa8d13f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Get-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 16754F70-9619-4F68-86E9-5C8B27812707 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/get-azurermvpnclientrootcertificate -schema: 2.0.0 ---- - -# Get-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Gets information about VPN root certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmVpnClientRootCertificate [-VpnClientRootCertificateName <String>] - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmVpnClientRootCertificate** cmdlet returns information about the root certificates assigned to a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. - -By default, **Get-AzureRmVpnClientRootCertificate** returns information about all the root certificates assigned to a gateway. -(Gateways can have more than one root certificate.) However, by including the **VpnClientRootCertificateName** parameter you can limit the returned data to a specific certificate. - -## EXAMPLES - -### Example 1: Get information about all root certificates -``` -PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -``` - -This command gets information about all the root certificates assigned to a virtual network gateway named ContosoVirtualNetwork. - -### Example 2: Get information about specific root certificates -``` -PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRootCertificateName "ContosoRootClientCertificate" -``` - -This command is a variation of the command shown in Example 1. -In this case, however, the *VpnClientRootCertificateName* parameter is included in order to limit the returned data to a specific root certificate: ContosoRootClientCertificate. - -## 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 the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway where the root certificate is assigned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet gets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### -**Get-AzureRmVpnClientRootCertificate** gets instances of the **Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Move-AzureRmExpressRouteCircuit.md b/azurermps-2.5.0/AzureRm.Network/Move-AzureRmExpressRouteCircuit.md deleted file mode 100644 index b3fe60118f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Move-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F845ED42-A7C1-4CCC-9AD8-E9A91C3EEC7A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/move-azurermexpressroutecircuit -schema: 2.0.0 ---- - -# Move-AzureRmExpressRouteCircuit - -## SYNOPSIS -Moves an ExpressRoute circuit from the classic deployment model to the Resource Manager deployment model. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> - -ServiceKey <String> [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Move-AzureRmExpressRouteCircuit** cmdlet moves an ExpressRoute circuit from the classic -deployment model to the Resource Manager deployment model. After the move, the ExpressRoute circuit -behaves and performs like any other ExpressRoute circuit that is created in the Resource Manager -deployment model. Circuit links, virtual networks, and VPN gateways are not moved through this -operation. Those resources need to be reconfigured after the move. - -## EXAMPLES - -### Example 1: Move an ExpressRoute circuit to the Resource Manager deployment model -``` -Move-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG -Location $Location -ServiceKey $ServiceKey -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The name of the Azure location where the ExpressRoute circuit resides. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit to be moved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group that will contain the ExpressRoute circuit being moved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceKey -The Service Key used by the ExpressRoute circuit in the classic deployment model. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](./New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](./Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGateway.md deleted file mode 100644 index 6ef6fc028c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGateway.md +++ /dev/null @@ -1,499 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1F5066C6-9756-47B4-886C-C52755809926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgateway -schema: 2.0.0 ---- - -# New-AzureRmApplicationGateway - -## SYNOPSIS -Creates an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String> - -Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>] - -GatewayIPConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration]> - [-SslCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate]>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-FrontendIPConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration]>] - -FrontendPorts <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort]> - [-Probes <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe]>] - -BackendAddressPools <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]> - -BackendHttpSettingsCollection <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings]> - -HttpListeners <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener]> - [-UrlPathMaps <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap]>] - -RequestRoutingRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule]> - [-RedirectConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration]>] - [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGateway** cmdlet creates an Azure application gateway. - -An application gateway requires the following: - -- A resource group. -- A virtual network. -- A back-end server pool, containing the IP addresses of the back-end servers. -- Back-end server pool settings. Each pool has settings such as port, protocol and cookie-based affinity, that are applied to all servers within the pool. -- Front-end IP addresses, which are the IP addresses opened on the application gateway. A front-end IP address can be a public IP address or an internal IP address. -- Front-end ports, which are the public ports opened on the application gateway. Traffic that hits these ports is redirected to the back-end servers. -- A request routing rule that binds the listener and the back-end server pool. The rule defines which back-end server pool the traffic should be directed to when it hits a particular listener. - -A listener has a front-end port, front-end IP address, protocol (HTTP or HTTPS) and Secure Sockets -Layer (SSL) certificate name (if configuring SSL offload). - -## EXAMPLES - -### Example 1: Create an application gateway -``` -PS C:\> $ResourceGroup = New-AzureRmResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"} -PS C:\> $Subnet = New-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24 -PS C:\> $VNet = New-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet -PS C:\> $VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name $Subnet01 -VirtualNetwork $VNet -PS C:\> $GatewayIPconfig = New-AzureRmApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet -PS C:\> $Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3 -PS C:\> $PoolSetting = New-AzureRmApplicationGatewayBackendHttpSettings -Name "PoolSetting01" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" -PS C:\> $FrontEndPort = New-AzureRmApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 -# Create a public IP address -PS C:\> $PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $FrontEndIpConfig = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp -PS C:\> $Listener = New-AzureRmApplicationGatewayHttpListener -Name "ListenerName01" -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort -PS C:\> $Rule = New-AzureRmApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool -PS C:\> $Sku = New-AzureRmApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2 -PS C:\> $Gateway = New-AzureRmApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku -``` - -The following example creates an application gateway by first creating a resource group and a -virtual network, as well as the following: - -- A back-end server pool -- Back-end server pool settings -- Front-end ports -- Front-end IP addresses -- A request routing rule - -These four commands create a virtual network. -The first command creates a subnet configuration. -The second command creates a virtual network. -The third command verifies the subnet configuration and the fourth command verifies that the virtual network is created successfully. - -The following commands create the application gateway. -The first command creates an IP configuration named GatewayIp01 for the subnet created previously. -The second command creates a back-end server pool named Pool01 with a list of back-end IP addresses and stores the pool in the $Pool variable. -The third command creates the settings for the back-end server pool and stores the settings in the $PoolSetting variable. -The forth command creates a front-end port on port 80, names it FrontEndPort01, and stores the port in the $FrontEndPort variable. -The fifth command creates a public IP address by using New-AzureRmPublicIpAddress. -The sixth command creates a front-end IP configuration using $PublicIp, names it FrontEndPortConfig01, and stores it in the $FrontEndIpConfig variable. -The seventh command creates a listener using the previously created $FrontEndIpConfig $FrontEndPort. -The eighth command creates a rule for the listener. -The ninth command sets the SKU. -The tenth command creates the gateway using the objects set by the previous commands. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendAddressPools -Specifies the list of back-end address pools for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackendHttpSettingsCollection -Specifies the list of back-end HTTP settings for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings] -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurations -Specifies a list of front-end IP configurations for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrontendPorts -Specifies a list of front-end ports for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayIPConfigurations -Specifies a list of IP configurations for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HttpListeners -Specifies a list of HTTP listeners for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Probes -Specifies probes for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RedirectConfigurations -The list of redirect configuration - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RequestRoutingRules -Specifies a list of request routing rules for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the stock keeping unit (SKU) of the application gateway. - -```yaml -Type: PSApplicationGatewaySku -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslCertificates -Specifies the list of Secure Sockets Layer (SSL) certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SslPolicy -Specifies an SSL policy for the application gateway. - -```yaml -Type: PSApplicationGatewaySslPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UrlPathMaps -Specifies URL path maps for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApplicationFirewallConfiguration -Specifies a web application firewall (WAF) configuration. You can use the -Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration cmdlet to get a WAF. - -```yaml -Type: PSApplicationGatewayWebApplicationFirewallConfiguration -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendHttpSettings](./New-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index a6c3a75b0c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4736FA0D-222D-4D69-BCBD-72036303A20E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Creates an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayAuthenticationCertificate -Name <String> -CertificateFile <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet creates an authentication certificate for an Azure application gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -CertificateFile -Specifies the path of the authentication certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the authentication certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index 7dd7c92cd3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C257E62F-1535-4626-A12B-F4572D00BB13 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Creates a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayBackendAddressPool -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayBackendAddressPool** cmdlet creates a back-end address pool for an Azure application gateway. -A back-end address can be specified as an IP address, a fully-qualified domain name (FQDN) or an IP configuration ID. - -## EXAMPLES - -### Example 1: Create a back-end address pool by using the FQDN of a back-end server -``` -PS C:\>$Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool01" -BackendFqdns "contoso1.com", "contoso2.com" -``` - -This command creates a back-end address pool named Pool01 by using the FQDNs of back-end servers, and stores it in the $Pool variable. - -### Example 2: Create a back-end address pool by using the IP address of a back-end server -``` -PS C:\>$Pool = New-AzureRmApplicationGatewayBackendAddressPool -Name "Pool02" -BackendFqdns "10.10.10.10", "10.10.10.11" -``` - -This command creates a back-end address pool named Pool02 by using the IP addresses of back-end servers, and stores it in the $Pool variable. - -## PARAMETERS - -### -BackendFqdns -Specifies a list of back-end FQDNs that this cmdlet associates with the back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -Specifies a list of back-end IP addresses that this cmdlet associates with the back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 back-end server pool that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index a639d3b7b4..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Creates back-end HTTP settings for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayBackendHttpSettings -Name <String> -Port <Int32> -Protocol <String> - -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-ProbeEnabled] - [-Path <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmApplicationGatewayBackendHttpSettings cmdlet creates back-end HTTP settings for an application gateway. -Back-end HTTP settings are applied to all back-end servers in a pool. - -## EXAMPLES - -### Example 1: Create back-end HTTP settings -``` -PS C:\>$Setting = New-AzureRmApplicationGatewayBackendHttpSettings -Name "Setting01" -Port 80 -Protocol Http -CookieBasedAffinity Disabled -``` - -This command creates back-end HTTP settings named Setting01 on port 80, using the HTTP protocol, with cookie-based affinity disabled. -The settings are stored in the $Setting variable. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the back-end server pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port of the back-end server pool. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with the back-end server pool. - -```yaml -Type: PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeEnabled -Flag if probe should be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end server pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for communication between the application gateway and the back-end servers. -The acceptable values for this parameter are: Http and Https. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies a request time-out value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index 61ff0954ae..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Creates a new connection draining configuration for back-end HTTP settings. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayConnectionDraining -Enabled <Boolean> -DrainTimeoutInSec <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayConnectionDraining** cmdlet creates a new connection draining configuration for back-end HTTP settings. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $connectionDraining = New-AzureRmApplicationGatewayConnectionDraining -Enabled $True -DrainTimeoutInSec 42 -``` - -The command creates a new connection draining configuration with Enabled set to True and DrainTimeoutInSec set to 42 seconds and stores it in $connectionDraining. - -## 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 -``` - -### -DrainTimeoutInSec -The number of seconds connection draining is active. -Acceptable values are from 1 second to 3600 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether connection draining is enabled or not. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayConnectionDraining - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md deleted file mode 100644 index 00740a3be6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfirewalldisabledrulegroupconfig -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig - -## SYNOPSIS -Creates a new disabled rule group configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName <String> - [-Rules <System.Collections.Generic.List`1[System.Int32]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig** cmdlet creates a new disabled rule group configuration. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $disabledRuleGroup1 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 -``` - -The command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. The new disabled rule group configuration is saved in $disabledRuleGroup1. - -## 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 -``` - -### -RuleGroupName -The name of the rule group that will be disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rules -The list of rules that will be disabled. -If null, all rules of the rule group will be disabled. - -```yaml -Type: System.Collections.Generic.List`1[System.Int32] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index a3bdbe2974..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AE8E26F2-CF8E-4340-936D-230731B5BA32 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Creates a front-end IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-SubnetId <String>] - [-PublicIPAddressId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayFrontendIPConfig -Name <String> [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] - [-PublicIPAddress <PSPublicIpAddress>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFrontendIPConfig** cmdlet creates a front-end IP configuraton for an Azure application gateway. -An application gateway supports two types of front-end IP configuration: - -- Public IP addresses - -- Private IP addresses using internal load balancing (ILB). - -An application gateway can have at most one public IP address and one private IP address. -The public IP address and private IP address should be added separately as front-end IP addresses. - -## EXAMPLES - -### Example 1: Create a front-end IP configuration using a public IP resource object -``` -PS C:\>$PublicIP = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIP01" -location "West US" -AllocationMethod Dynamic -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -PublicIPAddress $PublicIP -``` - -The first command creates a public IP resource object and stores it in the $PublicIP variable. -The second command uses $PublicIP to create a new front-end IP configuration named FrontEndIP01 and stores it in the $FrontEnd variable. - -### Example 2: Create a static private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command creates a front-end IP configuration named FrontEndIP02 using $Subnet from the second command and the private IP address 10.0.1.1, and then stores it in the $FrontEnd variable. - -### Example 3: Create a dynamic private IP as the front-end IP address -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $FrontEnd = New-AzureRmApplicationGatewayFrontendIPConfig -Name "FrontendIP03" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. -The third command creates a front-end IP configuration named FrontEndIP03 using $Subnet from the second command, and stores it in the $FrontEnd variable. - -## 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 -Specifies the name of the front-end IP configuration that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address which this cmdlet associates with the front-end IP address of the application gateway. -This can be specified only if a subnet is specified. -This IP is statically allocated from the subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address object which this cmdlet associates with the front-end IP address of the application gateway. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the public IP address ID which this cmdlet associates with the front-end IP of the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object which this cmdlet associates with the front-end IP address of the application gateway. -If you specify this parameter, it implies that the gateway uses a private IP address. -If the *PrivateIPAddresss* parameter is specified, it should belong to the subnet specified by this parameter. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID which this cmdlet associates with the front-end IP configuration of the application gateway. -If you specify the *Subnet* parameter, it implies that the gateway uses a private IP address. -If the *PrivateIPAddress* parameter is specified, it should belong to the subnet specified by *Subnet*. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendPort.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 8605db1d7c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3C046A0A-A2B6-413C-8D3B-8991A1FC4926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayfrontendport -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Creates a front-end port for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayFrontendPort -Name <String> -Port <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayFrontendPort** cmdlet creates a front-end port for an Azure application gateway. - -## EXAMPLES - -### Example1: Create a front-end port -``` -PS C:\>$FrontEndPort = New-AzureRmApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80 -``` - -This command creates a front-end port named FrontEndPort01 on port 80 and stores the result in the variable named $FrontEndPort. - -## 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 -Specifies the name of the front-end port that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number of the front-end port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFrontendPort - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayHttpListener.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index 5c2dfa8c0f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AF8CC409-2EA7-4EC1-86C9-E7A773DE9201 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayhttplistener -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Creates an HTTP listener for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayHttpListener -Name <String> [-FrontendIPConfigurationId <String>] - [-FrontendPortId <String>] [-SslCertificateId <String>] [-HostName <String>] - [-RequireServerNameIndication <String>] -Protocol <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayHttpListener -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayHttpListener** cmdlet creates an HTTP listener for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create an HTTP listener -``` -PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Http" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -``` - -This command creates an HTTP listener named Listener01 and stores the result in the variable named $Listener. - -### Example 2: Create an HTTP listener with SSL -``` -PS C:\>$Listener = New-AzureRmApplicationGatewayHttpListener -Name "Listener01" -Protocol "Https" -FrontendIpConfiguration $FIp01 -FrontendPort $FP01 -SslCertificate $SSLCert01 -``` - -This command creates an HTTP listener that uses SSL offload and provides the SSL certificate in the $SSLCert01 variable. -The command stores the result in the variable named $Listener. - -## 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 -``` - -### -FrontendIPConfiguration -Specifies front-end IP configuration object for the HTTP listener. - -```yaml -Type: PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the ID of the front-end IP configuration for the HTTP listener. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port for the HTTP listener. - -```yaml -Type: PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the ID of the front-end port object for the HTTP listener. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name of the application gateway HTTP listener. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that the HTTP listener uses. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate object for the HTTP listener. - -```yaml -Type: PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the ID of the SSL certificate for the HTTP listener. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 0d4a6d759c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 312AA609-7362-42A5-A889-C0784D5A2943 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayipconfiguration -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Creates an IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayIPConfiguration -Name <String> [-SubnetId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayIPConfiguration -Name <String> [-Subnet <PSSubnet>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayIPConfiguration** cmdlet creates an IP configuration for an application gateway. -The IP configuration contains the subnet in which application gateway is deployed. - -## EXAMPLES - -### Example 1: Create an IP configuration for an application gateway. -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\ $GatewayIpConfig = New-AzureRmApplicationGatewayIPConfiguration -Name "AppGwSubnet01" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01. - -The second command gets the subnet configuration for the subnet that the virtual network in the previous command belongs to, and stores it in the $Subnet variable. - -The third command creates the IP configuration using $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 -``` - -### -Name -Specifies the name of the IP configuration to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet object. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -This is the subnet in which the application gateway would be deployed. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayPathRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayPathRuleConfig.md deleted file mode 100644 index fd39c53324..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayPathRuleConfig.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A1F949A9-7AEF-41C1-B757-114421B79493 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaypathruleconfig -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayPathRuleConfig - -## SYNOPSIS -Creates an application gateway path rule. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayPathRuleConfig -Name <String> - -Paths <System.Collections.Generic.List`1[System.String]> [-BackendAddressPoolId <String>] - [-BackendHttpSettingsId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayPathRuleConfig -Name <String> - -Paths <System.Collections.Generic.List`1[System.String]> - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayPathRuleConfig** cmdlet creates an application gateway path rule. -Rules created by this cmdlet can be added to a collection of URL path map configuration settings and then assigned to a gateway. - -Path map configuration settings are used in application gateway load balancing. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$Gateway = Get-AzureRmApplicationGateway -Name "ContosoApplicationGateway" -PS C:\> $AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2" -PS C:\> $HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" -PS C:\> $PathRuleConfig = New-AzureRmApplicationGatewayPathRuleConfig -Name "base" -Paths "/base" -BackendAddressPool $AddressPool -BackendHttpSettings $HttpSettings -PS C:\> Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway $Gateway -Name "ContosoUrlPathMap" -PathRules $PathRuleConfig -DefaultBackendAddressPool $AddressPool -DefaultBackendHttpSettings $HttpSettings -``` - -These commands create a new application gateway path rule and then use the **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet to assign that rule to an application gateway. -To do this, the first command creates an object reference to the gateway ContosoApplicationGateway. -This object reference is stored in a variable named $Gateway. - -The next two commands create a backend address pool and a backend HTTP settings object; these objects (stored in the variables $AddressPool and $HttpSettings) are needed in order to create a path rule object. - -The fourth command creates the path rule object and is stored in a variable named $PathRuleConfig. - -The fifth command uses **Add-AzureRmApplicationGatewayUrlPathMapConfig** to add the configuration settings and the new path rule contained within those settings to ContosoApplicationGateway. - -## PARAMETERS - -### -BackendAddressPool -Specifies an object reference to a collection of backend address pool settings to be added to the gateway path rules configuration settings. -You can create this object reference by using the New-AzureRmApplicationGatewayBackendAddressPool cmdlet and syntax similar to this: - -`$AddressPool = New-AzureRmApplicationGatewayBackendAddressPool -Name "ContosoAddressPool" -BackendIPAddresses "192.168.1.1", "192.168.1.2"` - -The preceding command adds two IP addresses (192.16.1.1 and 192.168.1.2) to the address pool. -Note that the IP address are enclosed in quote marks and separated by using commas. - -The resulting variable, $AddressPool, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter. - -The backend address pool represents the IP addresses on the backend servers. -These IP addresses should either belong to the virtual network subnet or should be public IP addresses. -If you use this parameter you cannot use the *DefaultBackendAddressPoolId* parameter in the same command. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of an existing backend address pool that can be added to the gateway path rule configuration settings. -Address pool IDs can be returned by using the Get-AzureRmApplicationGatewayBackendAddressPool cmdlet. -After you have the ID you can then use the *DefaultBackendAddressPoolId* parameter instead of the *DefaultBackendAddressPool* parameter. -For instance: - --DefaultBackendAddressPoolId "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendAddressPools/ContosoAddressPool" - -The backend address pool represents the IP addresses on the backend servers. -These IP addresses should either belong to the virtual network subnet or should be public IP addresses. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies an object reference to a collection of backend HTTP settings to be added to the gateway path rule configuration settings. -You can create this object reference by using the New-AzureRmApplicationGatewayBackendHttpSettings cmdlet and syntax similar to this: - -$HttpSettings = New-AzureRmApplicationGatewayBackendHttpSettings -Name "ContosoHttpSetings" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled" - -The resulting variable, $HttpSettings, can then be used as the parameter value for the *DefaultBackendAddressPool* parameter: - --DefaultBackendHttpSettings $HttpSettings - -The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. -If you use this parameter you cannot use the *DefaultBackendHttpSettingsId* parameter in the same command. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the ID of an existing backend HTTP settings collection that can be added to the gateway path rule configuration settings. -HTTP setting IDs can be returned by using the Get-AzureRmApplicationGatewayBackendHttpSettings cmdlet. -After you have the ID you can then use the *DefaultBackendHttpSettingsId* parameter instead of the *DefaultBackendHttpSettings* parameter. -For instance: - --DefaultBackendSettings Id "/subscriptions/39c54063-01d3-4abf-8f4c-234777bc1f10/resourceGroups/appgw-rg/providers/Microsoft.Network/applicationGateways/appgwtest/backendHttpSettingsCollection/ContosoHttpSettings" - -The backend HTTP settings configure properties such as port, protocol, and cookie-based affinity for a backend pool. -If you use this parameter you cannot use the *DefaultBackendHttpSettings* parameter in the same command. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the path rule configuration that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Paths -Specifies one or more application gateway path rules. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -**New-AzureRmApplicationGatewayPathRuleConfig** does not accept pipelined input. - -## OUTPUTS - -### -**New-AzureRmApplicationGatewayPathRuleConfig** creates new instances of the **Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendHttpSettings](./New-AzureRmApplicationGatewayBackendHttpSettings.md) - -[New-AzureRmApplicationGatewayPathRuleConfig](./New-AzureRmApplicationGatewayPathRuleConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index c53ceb957d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayprobeconfig -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Creates a health probe. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayProbeConfig -Name <String> -Protocol <String> [-HostName <String>] -Path <String> - -Interval <Int32> -Timeout <Int32> -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] - [-MinServers <Int32>] [-Match <PSApplicationGatewayProbeHealthResponseMatch>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmApplicationGatewayProbeConfig cmdlet creates a health probe. - -## EXAMPLES - -### Example1: Create a health probe -``` -PS C:\>New-AzureRmApplicationGatewayProbeConfig -Name "Probe03" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command creates a health probe named Probe03, with HTTP protocol, a 30 second interval, timeout of 120 seconds, and an unhealthy threshold of 8 retries. - -## 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 -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid paths start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe - -## NOTES - -## RELATED LINKS - -[Create custom probe for Application Gateway using PowerShell for Azure Resource Manager](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md deleted file mode 100644 index f50e81eacf..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayProbeHealthResponseMatch.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayprobehealthresponsematch -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayProbeHealthResponseMatch - -## SYNOPSIS -Creates a health probe response match used by Health Probe for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayProbeHealthResponseMatch [-Body <String>] - [-StatusCode <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -**The Add-AzureRmApplicationGatewayProbeHealthResponseMatch** cmdlet creates a health probe response match used by Health Probe for an application gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$responsematch = New-AzureRmApplicationGatewayProbeHealthResponseMatch -Body "helloworld" -StatusCode "200-399","503" -``` - -This command creates a health response match which can be passed to ProbeConfig as a parameter. - -## PARAMETERS - -### -Body -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StatusCode -Allowed ranges of healthy status codes.Default range of healthy status codes is 200 - 399 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbeHealthResponseMatch - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index c3aa933d6e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Creates a redirect configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> - [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> - [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -New-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -RedirectType <String> [-TargetUrl <String>] - [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -**The New-AzureRmApplicationGatewayRedirectConfiguration** cmdlet creates a redirect configuration for an application gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$RedirectConfig = New-AzureRmApplicationGatewayRedirectConfiguration -Name "Redirect01" -RedirectType Permanent -TargetListener $listener01 -``` - -This command creates a redirect configuration named Redirect01 and stores the result in the variable named $RedirectConfig. - -## 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 -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: String -Parameter Sets: SetByURL -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRedirectConfiguration - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index f88edbc953..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 622FE9AC-1CC4-489C-BB17-9D6B9D1C151D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Creates a request routing rule for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> - [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] [-BackendAddressPoolId <String>] - [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -RuleType <String> - [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The Add-AzureRmApplicationGatewayRequestRoutingRule** cmdlet creates a request routing rule for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a request routing rule for an application gateway -``` -PS C:\>$Rule = New-AzureRmApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -This command creates a basic request routing rule named Rule01 and stores the result in the variable named $Rule. - -## PARAMETERS - -### -BackendAddressPool -Specifies the back-end address pool, as an object, for the request routing rule to create. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the back-end address pool ID of the request routing rule to create. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies the back-end HTTP settings, as an object, for the request routing rule to create. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the back-end HTTP settings ID of the request routing rule to create. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies the back-end HTTP listener for the request routing rule to create. - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies the backend HTTP listener ID for the request routing rule to create. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies type of the request routing rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySku.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySku.md deleted file mode 100644 index 3f913d1d87..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 48C33FAF-83C1-4725-AD2A-CF48D0718182 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysku -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewaySku - -## SYNOPSIS -Creates a SKU for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySku -Name <String> -Tier <String> -Capacity <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySku** cmdlet creates a stock keeping unit (SKU) for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a SKU for an Azure application gateway -``` -PS C:\>$SKU = New-AzureRmApplicationGatewaySku -Name "Standard_Small" -Tier "Standard" -Capacity 2 -``` - -This command creates a SKU named Standard_Small for an Azure application gateway and stores the result in the variable named $SKU. - -## PARAMETERS - -### -Capacity -Specifies the number of instances of an application gateway. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 SKU. - -The acceptable values for this parameter are: - -- Standard_Small -- Standard_Medium -- Standard_Large -- WAF_Medium -- WAF_Large - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Specifies the tier of the SKU. -The acceptable values for this parameter are: - -- Standard -- WAF - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, WAF - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySku](./Get-AzureRmApplicationGatewaySku.md) - -[Set-AzureRmApplicationGatewaySku](./Set-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslCertificate.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index f3e53a346e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6FFE1B64-C80B-423D-A043-55C90A224752 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysslcertificate -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Creates an SSL certificate for an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySslCertificate -Name <String> -CertificateFile <String> -Password <SecureString> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySslCertificate** cmdlet creates an SSL certificate for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create an SSL certificate for an Azure application gateway. -``` -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $cert = New-AzureRmApplicationGatewaySslCertificate -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command creates a SSL certificate named Cert01 for the default application gateway and stores the result in the variable named $Cert. - -## PARAMETERS - -### -CertificateFile -Specifies the path of the .pfx file of the SSL certificate that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 SSL certificate that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL that this cmdlet creates. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslCertificate - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslPolicy.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 762bbe8d3b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 98FA4E95-CAC5-4FBD-AA84-113BE9ED7FEA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaysslpolicy -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Creates an SSL policy for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewaySslPolicy - [-DisabledSslProtocols <System.Collections.Generic.List`1[System.String]>] [-PolicyType <String>] - [-PolicyName <String>] [-CipherSuite <System.Collections.Generic.List`1[System.String]>] - [-MinProtocolVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewaySslPolicy** cmdlet creates an SSL policy for an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$sslPolicy = New-AzureRmApplicationGatewaySslPolicy -PolicyType Custom -MinProtocolVersion TLSv1_1 -CipherSuite "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_GCM_SHA256" -``` - -This command creates a custom policy. - -## PARAMETERS - -### -CipherSuite -Ssl cipher suites to be enabled in the specified order to application gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledSslProtocols -Specifies which protocols are disabled. -The acceptable values for this parameter are: - -- TLSv1_0 -- TLSv1_1 -- TLSv1_2 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinProtocolVersion -Minimum version of Ssl protocol to be supported on application gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of Ssl predefined policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType -Type of Ssl Policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Predefined, Custom - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewaySslPolicy - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index 9ab9d1ef66..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F312FD6E-AF0F-4901-B763-741E1B46A654 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Creates an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet creates an array of URL path mappings to a backend server pool. - -## EXAMPLES - -### Example 1: Create an array of URL path mappings to a backend server pool -``` -PS C:\>New-AzureRmApplicationGatewayUrlPathMapConfig -Name $UrlPathMapName -PathRules $VideoPathRule, $ImagePathRule -DefaultBackendAddressPool $Pool -DefaultBackendHttpSettings $PoolSetting02 -``` - -This command creates an array of URL path mappings to a backend server pool. - -## PARAMETERS - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -Note that the path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayUrlPathMap - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index 94d690d58f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 76DB6AF5-BF6F-436C-8500-626468F84466 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 ---- - -# New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Creates a WAF configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -Enabled <Boolean> -FirewallMode <String> - [-RuleSetType <String>] [-RuleSetVersion <String>] - [-DisabledRuleGroups <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet creates a web application firewall (WAF) configuration for an Azure application gateway. - -## EXAMPLES - -### Example 1: Create a web application firewall configuration for an application gateway -``` -PS C:\> $disabledRuleGroup1 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-942-APPLICATION-ATTACK-SQLI" -Rules 942130,942140 -PS C:\> $disabledRuleGroup2 = New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig -RuleGroupName "REQUEST-921-PROTOCOL-ATTACK" -PS C:\> $firewallConfig = New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -Enabled $true -FirewallMode "Prevention" -RuleSetType "OWASP" -RuleSetVersion "3.0" -DisabledRuleGroups $disabledRuleGroup1,$disabledRuleGroup2 -``` - -The first command creates a new disabled rule group configuration for the rule group named "REQUEST-942-APPLICATION-ATTACK-SQLI" with rule 942130 and rule 942140 being disabled. -The second command creates another disabled rule group configuration for a rule group named "REQUEST-921-PROTOCOL-ATTACK". No rules are specifically passed and thus all rules of the rule group will be disabled. -The last command then creates a WAF configuration with firewall rules disabled as configured in $disabledRuleGroup1 and $disabledRuleGroup2. The new WAF configuration is stored in the $firewallConfig variable. - -## 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 -``` - -### -DisabledRuleGroups -The disabled rule groups. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether the WAF is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallMode -Specifies the web application firewall mode. -The acceptable values for this parameter are: - -- Detection -- Prevention - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Detection, Prevention - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetType -The type of the web application firewall rule set. -The acceptable values for this parameter are: - -- OWASP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OWASP - -Required: False -Position: Named -Default value: OWASP -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetVersion -The version of the rule set type. -The acceptable values for this parameter are: - -- 3.0 -- 2.2.9 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: 3.0, 2.2.9 - -Required: False -Position: Named -Default value: 3.0 -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayWebApplicationFirewallConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index 8502112867..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermapplicationsecuritygroup -schema: 2.0.0 ---- - -# New-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Creates an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmApplicationSecurityGroup -ResourceGroupName <String> -Name <String> -Location <String> - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmApplicationSecurityGroup** cmdlet creates an application security group. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyApplicationSecurityGroup" -Location "West US" -``` - -This example creates an application security group with no associations. Once it is created, IP configurations in the network interface can be included in the group. Security rules may also refer to the group as their sources or destinations. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 if you want to overwrite a resource. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the application security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the application security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationSecurityGroup](./Get-AzureRmApplicationSecurityGroup.md) - -[Remove-AzureRmApplicationSecurityGroup](./Remove-AzureRmApplicationSecurityGroup.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuit.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuit.md deleted file mode 100644 index 089cd61cda..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E40CAF2F-ED57-4AC1-8B9A-E48042DD8F91 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuit -schema: 2.0.0 ---- - -# New-AzureRmExpressRouteCircuit - -## SYNOPSIS -Creates an Azure express route circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> -Location <String> - [-SkuTier <String>] [-SkuFamily <String>] -ServiceProviderName <String> -PeeringLocation <String> - -BandwidthInMbps <Int32> - [-Peering <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPeering]>] - [-Authorization <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization]>] - [-AllowClassicOperations <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuit** cmdlet creates an Azure express route circuit. - -## EXAMPLES - -### Example 1: Create a new ExpressRoute circuit -``` -$parameters = @{ - Name='ExpressRouteCircuit' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - SkuTier='Standard' - SkuFamily='MeteredData' - ServiceProviderName='Equinix' - PeeringLocation='Silicon Valley' - BandwidthInMbps=200 -} -New-AzureRmExpressRouteCircuit @parameters -``` - -## PARAMETERS - -### -AllowClassicOperations -The use of this parameter allows you to use the classic Azure PowerShell cmdlets to manage the -circuit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -A list of circuit authorizations. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BandwidthInMbps -The bandwidth of the circuit. This must be a value that is supported by the service provider. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Peering -A list peer configurations. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPeering] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeeringLocation -The name of the peering location supported by the service provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group that will contain the circuit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceProviderName -The name of the circuit service provider. This must match a name listed by the -Get-AzureRmExpressRouteServiceProvider cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuFamily -SKU family determines the billing type. Possible values for this parameter are: `MeteredData` or -`UnlimitedData`. Note that you can change the billing type from MeteredData to UnlimitedData, but -you can't change the type from UnlimitedData to MeteredData. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: MeteredData, UnlimitedData - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuTier -The tier of service for the circuit. Possible values for this parameter are: `Standard` or `Premium`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, Premium - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](Remove-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index 58af7d7a89..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B6E55944-1B78-463F-9FC9-98097FEEC278 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuitauthorization -schema: 2.0.0 ---- - -# New-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Creates an ExpressRoute circuit authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmExpressRouteCircuitAuthorization -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuitAuthorization** cmdlet creates a circuit authorization that can -be added to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the -Microsoft cloud by using a connectivity provider instead of the public Internet. The owner of an -ExpressRoute circuit can create as many as 10 authorizations for each circuit; these authorizations -generate an authorization key that can be used by a virtual network owner to connect a network to -the circuit. There can only one authorization per virtual network. - -After you create an ExpressRoute circuit you can use -**Add-AzureRmExpressRouteCircuitAuthorization** to add an authorization to that circuit. -Alternatively, you can use **New-AzureRmExpressRouteCircuitAuthorization** to create an -authorization that can be added to a new circuit at the same time the circuit is created. - -## EXAMPLES - -### Example 1: Create a new circuit authorization -``` -$Authorization = New-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -``` - -This command creates a new circuit authorization named ContosoCircuitAuthorization and then stores -that object in a variable named $Authorization. Saving the object to a variable is important: -although **New-AzureRmExpressRouteCircuitAuthorization** can create a circuit authorization it -cannot add that authorization to a circuit route. Instead, the variable $Authorization is used -New-AzureRmExpressRouteCircuit when creating a brand-new ExpressRoute circuit. - -For more information, see the documentation for the New-AzureRmExpressRouteCircuit cmdlet. - -## 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 -Specifies a unique name for the new ExpressRoute circuit authorization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept pipelined input. - -## OUTPUTS - -### PSExpressRouteCircuitAuthorization -This cmdlet creates instances of the **Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index e217303b43..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5E9C02BE-9DCC-4865-95D2-6B69D373BE77 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 ---- - -# New-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Creates a new peering configuration to be added to an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <Int32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <Int32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -New-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -PeeringType <String> -PeerASN <Int32> - -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmExpressRouteCircuitPeeringConfig** cmdlet adds a peering configuration to an -ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud -by using a connectivity provider instead of the public Internet. - -## EXAMPLES - -### Example 1: Create a new ExpressRoute circuit with a peering configuration -``` -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 200 -} -$PeerConfig = New-AzureRmExpressRouteCircuitPeeringConfig @parameters - -$parameters = @{ - Name='ExpressRouteCircuit' - ResourceGroupName='ExpressRouteResourceGroup' - Location='West US' - SkuTier='Standard' - SkuFamily='MeteredData' - ServiceProviderName='Equinix' - Peering=$PeerConfig - PeeringLocation='Silicon Valley' - BandwidthInMbps=200 -} -New-AzureRmExpressRouteCircuit @parameters -``` - -## 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 -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmIpsecPolicy.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmIpsecPolicy.md deleted file mode 100644 index 412cb688b9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmIpsecPolicy.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermipsecpolicy -schema: 2.0.0 ---- - -# New-AzureRmIpsecPolicy - -## SYNOPSIS -Creates an IPSec Policy. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmIpsecPolicy [-SALifeTimeSeconds <Int32>] [-SADataSizeKilobytes <Int32>] -IpsecEncryption <String> - -IpsecIntegrity <String> -IkeEncryption <String> -IkeIntegrity <String> -DhGroup <String> -PfsGroup <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmIpsecPolicy cmdlet creates an IPSec policy proposal to be used in a virtual network gateway connection. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $ipsecPolicy = New-AzureRmIpsecPolicy -SALifeTimeSeconds 1000 -SADataSizeKilobytes 2000 -IpsecEncryption "GCMAES256" -IpsecIntegrity "GCMAES256" -IkeEncryption "AES256" -IkeIntegrity "SHA256" -DhGroup "DHGroup14" -PfsGroup "PFS2048" -PS C:\> New-AzureRmVirtualNetworkGatewayConnection -ResourceGroupName $rgname -name $vnetConnectionName -location $location -VirtualNetworkGateway1 $vnetGateway -LocalNetworkGateway2 $localnetGateway -ConnectionType IPsec -RoutingWeight 3 -SharedKey $sharedKey -UsePolicyBasedTrafficSelectors $true -IpsecPolicies $ipsecPolicy -``` - -Creating an IPSec policy to be used for a new virtual network gateway connection. - -## 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 -``` - -### -DhGroup -The DH Groups used in IKE Phase 1 for initial SA - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: None, DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeEncryption -The IKE encryption algorithm (IKE Phase 2) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: DES, DES3, AES128, AES192, AES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IkeIntegrity -The IKE integrity algorithm (IKE Phase 2) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: MD5, SHA1, SHA256, SHA384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecEncryption -The IPSec encryption algorithm (IKE Phase 1) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecIntegrity -The IPSec integrity algorithm (IKE Phase 1) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PfsGroup -The DH Groups used in IKE Phase 2 for new child SA - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: None, PFS1, PFS2, PFS2048, PFS24, ECP256, ECP384 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SADataSizeKilobytes -The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SALifeTimeSeconds -The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancer.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancer.md deleted file mode 100644 index 746e0a8cb6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancer.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F1522074-7EEA-4DCF-AC16-26FE8E654720 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancer -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancer - -## SYNOPSIS -Creates a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancer -Name <String> -ResourceGroupName <String> -Location <String> [-Sku <String>] - [-FrontendIpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration]>] - [-BackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-Probe <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSProbe]>] - [-InboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-LoadBalancingRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule]>] - [-Tag <Hashtable>] - [-InboundNatPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatPool]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancer** cmdlet creates an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIp" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name "MyFrontEnd" -PublicIpAddress $publicip -PS C:\> $backendAddressPool = New-AzureRmLoadBalancerBackendAddressPoolConfig -Name "MyBackendAddPoolConfig02" -PS C:\> $probe = New-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath "healthcheck.aspx" -PS C:\> $inboundNatRule1 = New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule1" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 -IdleTimeoutInMinutes 15 -EnableFloatingIP -PS C:\> $inboundNatRule2 = New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyinboundNatRule2" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3391 -BackendPort 3392 -PS C:\> $lbrule = New-AzureRmLoadBalancerRuleConfig -Name "MyLBruleName" -FrontendIPConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol "Tcp" -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP -LoadDistribution SourceIP -PS C:\> $lb = New-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -Location "West US" -FrontendIpConfiguration $frontend -BackendAddressPool $backendAddressPool -Probe $probe -InboundNatRule $inboundNatRule1,$inboundNatRule2 -LoadBalancingRule $lbrule -PS C:\> Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -Deploying a load balancer requires that you first create several objects, and the first seven -commands show how to create those objects. - -The eighth command creates a load balancer named MyLoadBalancer in the resource group named -MyResourceGroup. - -The ninth and last command gets the new load balancer to ensure it was successfully created. - -Note that this example only shows how to create a load balancer. You must also configure it using -the Add-AzureRmNetworkInterfaceIpConfig cmdlet to assign the NICs to different virtual machines. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies a backend address pool to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -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. - -```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 -Indicates that this cmdlet creates a load balancer even if a load balancer with the same name already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InboundNatPool -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatPool] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InboundNatRule -Specifies a list of inbound network address translation (NAT) rules to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancingRule -Specifies a list of load balancing rules to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create a load balancer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer that this creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Probe -Specifies a list of probes to associate with a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSProbe] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create a load balancer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The load balancer Sku name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 50f7fdee65..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 67AD15B0-94EB-486F-8C17-606EA5F702D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Creates a backend address pool configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancerBackendAddressPoolConfig -Name <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet creates a backend address pool configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a backend address pool configuration for a load balancer -``` -PS C:\>New-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" -``` - -This command creates a backend address pool configuration named BackendAddressPool02 for a load balancer. - -## 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 -Specifies the name of the address pool configuration to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Remove-AzureRmLoadBalancerBackendAddressPoolConfig](./Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 9cc297fccb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D639E4F5-5AAD-4F13-9B48-70E90D2DFFCA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerfrontendipconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Creates a front-end IP configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] -Subnet <PSSubnet> - [-Zone <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> [-PrivateIpAddress <String>] -SubnetId <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> -PublicIpAddressId <String> - [-Zone <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -New-AzureRmLoadBalancerFrontendIpConfig -Name <String> -PublicIpAddress <PSPublicIpAddress> - [-Zone <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerFrontendIpConfig** cmdlet creates a front-end IP configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a front-end IP configuration for a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> New-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip -``` - -The first command creates a dynamic public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. - -The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip. - -## 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 -Specifies the front-end IP configuration that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address of the load balancer. -Specify this parameter only if you also specify the *Subnet* parameter. - -```yaml -Type: String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the **PublicIpAddress** object to associate with a front-end IP configuration. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the **PublicIpAddress** object to associate with a front-end IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the **Subnet** object in which to create a front-end IP configuration. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet in which to create a front-end IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFrontendIPConfiguration - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index b99232270b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 61C34433-A16A-4ACF-A318-1C7D9E49579F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> [-FrontendIpConfigurationId <String>] - -Protocol <String> -FrontendPortRangeStart <Int32> -FrontendPortRangeEnd <Int32> -BackendPort <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatPool - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index d1405cff53..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4AA587F8-4967-439D-84B6-EDC24235D3F5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Creates an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> [-FrontendIpConfigurationId <String>] - [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-EnableFloatingIP] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet creates an inbound network address translation (NAT) rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create an inbound NAT rule configuration for a load balancer -``` -PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip -PS C:\> New-AzureRmLoadBalancerInboundNatRuleConfig -Name "MyInboundNatRule" -FrontendIPConfiguration $frontend -Protocol "Tcp" -FrontendPort 3389 -BackendPort 3389 -``` - -The first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. - -The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. - -The third command creates an inbound NAT rule configuration named MyInboundNatRule using the front-end object in $frontend. -The TCP protocol is specified and the front-end port is 3389, the same as the backend port in this case. -The *FrontendIpConfiguration*, *Procotol*, *FrontendPort*, and *BackendPort* parameters are all required to create an inbound NAT rule configuration. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the rule configuration that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies a protocol. -The acceptable values for this parameter are: - -- Tcp -- Udp - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSInboundNatRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index c7f9392313..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2049CB74-E3CB-4294-B97C-B41E91209A1E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerprobeconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Creates a probe configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLoadBalancerProbeConfig -Name <String> [-RequestPath <String>] [-Protocol <String>] -Port <Int32> - -IntervalInSeconds <Int32> -ProbeCount <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerProbeConfig** cmdlet creates a probe configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Create a probe configuration -``` -PS C:\>New-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 15 -``` - -This command creates a probe configuration named MyProbe using the HTTP protocol. -The new probe will connect to a load-balanced service on port 80. - -## 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 -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of a load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which the new probe should connect to a load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probe configuration. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Http - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in a load-balanced service to probe to determine health. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSProbe - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index 52e93b25f7..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: FD84D530-491B-4075-A6B4-2E1C46AD92D4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermloadbalancerruleconfig -schema: 2.0.0 ---- - -# New-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Creates a rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmLoadBalancerRuleConfig -Name <String> [-FrontendIpConfigurationId <String>] - [-BackendAddressPoolId <String>] [-ProbeId <String>] [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-LoadDistribution <String>] [-EnableFloatingIP] - [-DisableOutboundSNAT] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmLoadBalancerRuleConfig -Name <String> [-FrontendIpConfiguration <PSFrontendIPConfiguration>] - [-BackendAddressPool <PSBackendAddressPool>] [-Probe <PSProbe>] [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-LoadDistribution <String>] [-EnableFloatingIP] - [-DisableOutboundSNAT] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmLoadBalancerRuleConfig** cmdlet creates a rule configuration for an Azure load balancer. - -## EXAMPLES - -### 1: Creating a rule configuration for an Azure Load Balancer -``` -PS C:\> $publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" - -name MyPublicIP -location 'West US' -AllocationMethod Dynamic -PS C:\> $frontend = New-AzureRmLoadBalancerFrontendIpConfig -Name MyFrontEnd - -PublicIpAddress $publicip -PS C:\> $probe = New-AzureRmLoadBalancerProbeConfig -Name MyProbe -Protocol http -Port - 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath healthcheck.aspx -PS C:\> New-AzureRmLoadBalancerRuleConfig -Name "MyLBrule" -FrontendIPConfiguration - $frontend -BackendAddressPool $backendAddressPool -Probe $probe -Protocol Tcp - -FrontendPort 80 -BackendPort 80 -IdleTimeoutInMinutes 15 -EnableFloatingIP - -LoadDistribution SourceIP -``` - -The first three commands set up a public IP, a front end, and a probe for the rule configuration in the forth command. The forth command creates a new rule called MyLBrule with certain specifications. - -## PARAMETERS - -### -BackendAddressPool -Specifies a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by this load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. -The acceptable values for this parameter are: - -- Default -- SourceIP -- SourceIPProtocol - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Default, SourceIP, SourceIPProtocol - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancing rule that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by a load balancer rule configuration. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, All - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLocalNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmLocalNetworkGateway.md deleted file mode 100644 index bcc78c36c3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 59BE802E-C061-4E25-A446-B00B0BA36019 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermlocalnetworkgateway -schema: 2.0.0 ---- - -# New-AzureRmLocalNetworkGateway - -## SYNOPSIS -Creates a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmLocalNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-GatewayIpAddress <String>] [-AddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-Asn <UInt32>] [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. - -The **New-AzureRmLocalNetworkGateway** cmdlet creates the object representing your on-prem gateway -based on the Name, Resource Group Name, Location, and IP Address of the gateway, as well as the -Address Prefix of the On-Premises network which will be connecting to Azure. - -## EXAMPLES - -### 1: Create a Local Network Gateway -``` -New-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -Location "West US" -GatewayIpAddress 23.99.221.164 -AddressPrefix "10.5.51.0/24" -``` - -Creates the object of the Local Network Gateway with the name "myLocalGW" within the resource group -"myRG" in location "West US" with the IP address "23.99.221.164" and the address prefix -"10.5.51.0/24" on-prem. - -## PARAMETERS - -### -AddressPrefix -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -```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. - -```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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayIpAddress -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that the local network gateway belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[Remove-AzureRmLocalNetworkGateway](./Remove-AzureRmLocalNetworkGateway.md) - -[Set-AzureRmLocalNetworkGateway](./Set-AzureRmLocalNetworkGateway.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterface.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterface.md deleted file mode 100644 index 7446ca2517..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterface.md +++ /dev/null @@ -1,568 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: B2F2082F-4BAA-4FBE-8846-2D436A433570 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkinterface -schema: 2.0.0 ---- - -# New-AzureRmNetworkInterface - -## SYNOPSIS -Creates a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByIpConfigurationResource (Default) -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> - -IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]> - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByIpConfigurationResourceId -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> - -IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]> - [-NetworkSecurityGroupId <String>] [-NetworkSecurityGroup <PSNetworkSecurityGroup>] - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> -SubnetId <String> - [-PublicIpAddressId <String>] [-NetworkSecurityGroupId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-PrivateIpAddress <String>] - [-IpConfigurationName <String>] [-DnsServer <System.Collections.Generic.List`1[System.String]>] - [-InternalDnsNameLabel <String>] [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet> - [-PublicIpAddress <PSPublicIpAddress>] [-NetworkSecurityGroup <PSNetworkSecurityGroup>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-PrivateIpAddress <String>] [-IpConfigurationName <String>] - [-DnsServer <System.Collections.Generic.List`1[System.String]>] [-InternalDnsNameLabel <String>] - [-EnableIPForwarding] [-EnableAcceleratedNetworking] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkInterface** cmdlet creates an Azure network interface. - -## EXAMPLES - -### Example 1: Create an Azure network interface -``` -PS C:\>New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -IpConfigurationName "IPConfiguration1" -DnsServer "8.8.8.8", "8.8.4.4" -``` - -This command creates a network interface named NetworkInterface001 with a dynamically assigned -private IP address from Subnet1 in the virtual network named VirtualNetwork1. The command also -assigns two DNS servers to the network interface. The IPConfiguration child resource will be -created automatically using the name IPConfiguration1. - -### Example 2: Create an Azure network interface using an IP configuration object -``` -PS C:\>$IPconfig = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig1" -PrivateIpAddressVersion IPv4 -PrivateIpAddress "10.0.1.10" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -PS C:\> New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -IpConfiguration $IPconfig -``` - -This example creates a new network interface using an IP configuration object. The IP configuration -object specifies a static private IPv4 address. - -The first command creates a network interface IP configuration named IPConfig1 and stores the -configuration in the variable named $IPconfig. - -The second command creates a network interface named NetworkInterface1 that uses the network -interface IP configuration stored in the variable named $IPconfig. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies an **ApplicationGatewayBackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies the ID of a **ApplicationGatewayBackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which the network interface IP configuration should belong to. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which the network interface IP configuration should belong to. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsServer -Specifies the DNS server for the network interface. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAcceleratedNetworking -Enables accelerated networking. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableIPForwarding -Indicates that this cmdlet enables IP forwarding for the network interface. -IP forwarding allows a virtual machine to receive traffic addressed to other destinations. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the creation of the network interface even if a network interface with the same name already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InternalDnsNameLabel -Specifies the internal DNS name label for the new network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfiguration -Specifies the IP configuration that this cmdlet uses for the network interface. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration] -Parameter Sets: SetByIpConfigurationResource, SetByIpConfigurationResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurationName -Specifies the name of an IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a **BackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies an inbound NAT rule configuration for a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies the ID of an inbound NAT rule configuration for a load balancer. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region for a network interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: SetByIpConfigurationResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: String -Parameter Sets: SetByIpConfigurationResourceId, SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies a static IPv4 IP address to assign to this network interface. - -```yaml -Type: String -Parameter Sets: SetByResourceId, SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object to assign to a network interface. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of a **PublicIPAddress** object to assign to a network interface. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that the network interface belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a network interface for the subnet that this parameter specifies. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet for which to create a network interface. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterfaceIpConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 97a0913668..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D29C82CC-2080-48DA-880A-1AA83007E552 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkinterfaceipconfig -schema: 2.0.0 ---- - -# New-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Creates a network interface IP configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] - [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkInterfaceIpConfig -Name <String> [-PrivateIpAddressVersion <String>] - [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkInterfaceIpConfig** cmdlet creates an Azure network interface IP configuration for a network interface. - -## EXAMPLES - -### 1: Create an IP configuration with a public IP address for a network interface -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet -$PIP1 = Get-AzureRmPublicIPAddress -Name "PIP1" -ResourceGroupName "RG1" - -$IPConfig1 = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig-1" -Subnet $Subnet -PublicIpAddress $PIP1 - -Primary - - $nic = New-AzureRmNetworkInterface -Name $NicName -ResourceGroupName myrg -Location westus - -IpConfiguration $IpConfig1 -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were - previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously - created public IP address called PIP1. The forth command creates a new IP configuration called "IPConfig-1" as the - primary IP configuration with a public IP address associated with it. - The last command then creates a network interface called mynic1 using this IP configuration. - -### 2: Create an IP configuration with a private IP address -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet - -$IPConfig2 = New-AzureRmNetworkInterfaceIpConfig -Name "IP-Config2" -Subnet $Subnet -PrivateIpAddress - 10.0.0.5 - -$nic = New-AzureRmNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration - $IpConfig2 -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were - previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP - configuration called "IPConfig-2" with a private IP address 10.0.0.5 associated with it. - The last command then creates a network interface called mynic1 using this IP configuration. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound Nat Rule references to which this network interface IPConfiguration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. - -The acceptable values for this parameter are: - -- IPv4 -- IPv6 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index 727a5ca09d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A420B3E7-2FE9-4D0B-803E-AC28E5F23C59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworksecuritygroup -schema: 2.0.0 ---- - -# New-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Creates a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> -Location <String> - [-SecurityRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSecurityRule]>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkSecurityGroup** cmdlet creates an Azure network security group. - -## EXAMPLES - -### 1: Create a new network security group -``` -New-AzureRmNetworkSecurityGroup -Name "nsg1" -ResourceGroupName "rg1" -Location "westus" -``` - -This command creates a new Azure network security group named "nsg1" in resource group "rg1" in location "westus". - -### 2: Create a detailed network security group -``` -$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 - -$rule2 = New-AzureRmNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 - -$nsg = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestRG -Location westus -Name - "NSG-FrontEnd" -SecurityRules $rule1,$rule2 -``` - -Step:1 Create a security rule allowing access from the Internet to port 3389. -Step:2 Create a security rule allowing access from the Internet to port 80. -Step:3 Add the rules created above to a new NSG named NSG-FrontEnd. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for which to create a network security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -This cmdlet creates a network security group in the resource group that this parameter specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityRules -Specifies a list of network security rule objects to create in a network security group. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSecurityRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index 39465854b3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 633FB5C9-BEB3-42A3-AF4F-A54CC3F9E0F7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworksecurityruleconfig -schema: 2.0.0 ---- - -# New-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Creates a network security rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmNetworkSecurityRuleConfig -Name <String> [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmNetworkSecurityRuleConfig** cmdlet creates an Azure network security rule configuration for a network security group. - -## EXAMPLES - -### 1: Create a network security rule to allow RDP -``` -$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -``` - -This command creates a security rule allowing access from the Internet to port 3389 - -### 2: Create a network security rule that allows HTTP -``` -$rule2 = New-AzureRmNetworkSecurityRuleConfig -Name web-rule -Description "Allow HTTP" - -Access Allow -Protocol Tcp -Direction Inbound -Priority 101 -SourceAddressPrefix - Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 80 -``` - -This command creates a security rule allowing access from the Internet to port 80 - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the network security rule configuration to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: - -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address - -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: - -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated on incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are: An integer between 100 and 4096. - -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a new rule configuration applies to. -The acceptable values for this parameter are: - -- Tcp -- Udp -- wildcard character (*) to match both. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: - -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address. - -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies the source port or range. -The acceptable values for this parameter are: - -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSecurityRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcher.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcher.md deleted file mode 100644 index e8db61d289..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcher -schema: 2.0.0 ---- - -# New-AzureRmNetworkWatcher - -## SYNOPSIS -Creates a new Network Watcher resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> -Location <String> [-Tag <Hashtable>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcher cmdlet creates a new Network Watcher resource. - -## EXAMPLES - -### Example 1: Create a Network Watcher -``` -New-AzureRmResourceGroup -Name NetworkWatcherRG -Location westcentralus -New-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG - -Name : NetworkWatcher_westcentralus -Id : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_westcentralus -Etag : W/"7cf1f2fe-8445-4aa7-9bf5-c15347282c39" -Location : westcentralus -Tags : -ProvisioningState : Succeeded -``` - -This example creates a new Network Watcher inside a newly created Resource Group. Note that only -one Network Watcher can be created per region per subscription. - -## 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 -Location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The network watcher name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 6604beadc2..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcher -schema: 2.0.0 ---- - -# New-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Creates a connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> -Name <String> - -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] -``` - -### SetByName -``` -New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - -Name <String> -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] -``` - -### SetByLocation -``` -New-AzureRmNetworkWatcherConnectionMonitor -Location <String> -Name <String> -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcherConnectionMonitor cmdlet rcreates a connection monitor for a specified source and destination. - -## EXAMPLES - -### --------------- Example 1: Create a connection monitor for a vm and internet destination --------------- -``` -PS C:\> New-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm -DestinationAddress bing.com -DestinationPort 80 - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/t1 -Etag : W/"e86b28cf-b907-4475-a8b7-34d310367694" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 - 00000/resourceGroups/RgCentralUSEUAP/providers/Microsoft - .Compute/virtualMachines/vm", - "Port": 0 - } -Destination : { - "Address": "bing.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:13:11 PM -MonitoringStatus : Running -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : {} -``` - -The New-AzureRmNetworkWatcherConnectionMonitor cmdlet creates a connection monitor for a specified source and destination. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoStart -Auto start. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The Ip address of the connection monitor destination. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Destination port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationResourceId -The ID of the connection monitor destination. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MonitoringIntervalInSeconds -Monitoring interval in seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePort -Source port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceResourceId -The ID of the connection monitor source. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherPacketCapture.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index a766378de8..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermnetworkwatcherpacketcapture -schema: 2.0.0 ---- - -# New-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Creates a new packet capture resource and starts a packet capture session on a VM. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - -TargetVirtualMachineId <String> [-StorageAccountId <String>] [-StoragePath <String>] - [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] [-TotalBytesPerSession <Int32>] - [-TimeLimitInSeconds <Int32>] - [-Filter <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> -TargetVirtualMachineId <String> [-StorageAccountId <String>] - [-StoragePath <String>] [-LocalFilePath <String>] [-BytesToCapturePerPacket <Int32>] - [-TotalBytesPerSession <Int32>] [-TimeLimitInSeconds <Int32>] - [-Filter <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmNetworkWatcherPacketCapture cmdlet creates a new packet capture resource and starts a packet capture session on a VM. -The length of the Packet Capture sessions can be configured via a time constraint or a size constraint. The amount of data captured for each packet can also be configured. -Filters can be applied to a given packet capture session, allowing you to customize the type of packets captured. Filters can restrict packets on local and remote IP addresses & address ranges, local and remote ports & port ranges, and the session level protocol to be captured. Filters are composable, and multiple filters can be applied to provide you with granularity of capture. - -## EXAMPLES - -### --- Example 1: Create a Packet Capture with multiple filters --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filter $filter1, $filter2 -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. - -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BytesToCapturePerPacket -Bytes to capture per packet. - -```yaml -Type: Int32 -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. - -```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 -Filters for packet capture session. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalFilePath -Local file path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -Storage account Id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoragePath -Storage path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TimeLimitInSeconds -Time limit in seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TotalBytesPerSession -Total bytes per session. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String System.Nullable\`1\[\[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\]\] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPacketCapture - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmPacketCaptureFilterConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmPacketCaptureFilterConfig.md deleted file mode 100644 index 94fcbd19fd..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmPacketCaptureFilterConfig.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpacketcapturefilterconfig -schema: 2.0.0 ---- - -# New-AzureRmPacketCaptureFilterConfig - -## SYNOPSIS -Creates a new packet capture filter object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPacketCaptureFilterConfig [-Protocol <String>] [-RemoteIPAddress <String>] - [-LocalIPAddress <String>] [-LocalPort <String>] [-RemotePort <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmPacketCaptureFilterConfig cmdlet creates a new packet capture filter object. -This object is used to restrict the type of packets that are captured during a packet capture session using the specified criteria. -The New-AzureRmNetworkWatcherPacketCapture cmdlet can accept multiple filter objects to enable composable capture sessions. - -## EXAMPLES - -### --- Example 1: Create a Packet Capture with multiple filters --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$storageAccount = Get-AzureRmStorageAccount -ResourceGroupName contosoResourceGroup -Name contosostorage123 - -$filter1 = New-AzureRmPacketCaptureFilterConfig -Protocol TCP -RemoteIPAddress "1.1.1.1-255.255.255" -LocalIPAddress "10.0.0.3" -LocalPort "1-65535" -RemotePort "20;80;443" -$filter2 = New-AzureRmPacketCaptureFilterConfig -Protocol UDP -New-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -TargetVirtualMachineId $vm.Id -PacketCaptureName "PacketCaptureTest" -StorageAccountId $storageAccount.id -TimeLimitInSeconds 60 -Filters $filter1, $filter2 -``` - -In this example we create a packet capture named "PacketCaptureTest" with multiple filters and a time limit. Once the session is complete, it will be saved to the specified storage account. - -Note: The Azure Network Watcher extension must be installed on the target virtual machine to create packet captures. - -## 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 -``` - -### -LocalIPAddress -Specifies the Local IP Address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalPort -Specifies the Local IP Address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Protocol -Specifies the Procotol to filter on. Acceptable values "TCP","UDP","Any" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Specifies the remote IP address to filter on. -Example inputs: -"127.0.0.1" for single address entry. -"127.0.0.1-127.0.0.255" for range. -"127.0.0.1;127.0.0.5;" for multiple entries. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemotePort -Specifies the Remote Port to filter on. -Remote port -Example inputs: -"80" for single port entry. -"80-85" for range. -"80;443;" for multiple entries. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPacketCaptureFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, packet, capture, traffic, filter - -## RELATED LINKS - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmPublicIpAddress.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmPublicIpAddress.md deleted file mode 100644 index 5d0165881f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 8D84F81A-F6B5-413D-B349-50947FCD5CFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermpublicipaddress -schema: 2.0.0 ---- - -# New-AzureRmPublicIpAddress - -## SYNOPSIS -Creates a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmPublicIpAddress [-Name <String>] -ResourceGroupName <String> [-Location <String>] [-Sku <String>] - -AllocationMethod <String> [-IpAddressVersion <String>] [-DomainNameLabel <String>] [-ReverseFqdn <String>] - [-IdleTimeoutInMinutes <Int32>] [-Zone <System.Collections.Generic.List`1[System.String]>] [-Tag <Hashtable>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPublicIpAddress** cmdlet creates a public IP address. - -## EXAMPLES - -### 1: Create a new public IP address -``` -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -``` - -This command creates a new public IP address resource.A DNS record is created for -$dnsPrefix.$location.cloudapp.azure.com pointing to the public IP address of this resource. A -public IP address is immediately allocated to this resource as the -AllocationMethod is specified -as 'Static'. If it is specified as 'Dynamic', a public IP address gets allocated only when you -start (or create) the associated resource (like a VM or load balancer). - -### 2: Create a public IP address with a reverse FQDN -``` -$publicIp = New-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -AllocationMethod Static -DomainNameLabel $dnsPrefix -Location $location -ReverseFqdn $customFqdn -``` - -This command creates a new public IP address resource. With the -ReverseFqdn parameter, Azure -creates a DNS PTR record (reverse-lookup) for the public IP address allocated to this resource, -pointing to the $customFqdn specified in the command. As a pre-requisite, the $customFqdn (say -webapp.contoso.com) should have a DNS CNAME record (forward-lookup) pointing to -$dnsPrefix.$location.cloudapp.azure.com. - -## PARAMETERS - -### -AllocationMethod -Specifies the method with which to allocate the public IP address. -The acceptable values for this parameter are: Static or Dynamic. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Dynamic, Static - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNameLabel -Specifies the relative DNS name for a public IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the idle time-out, in minutes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpAddressVersion -Specifies the version of the IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the region in which to create a public IP address. - -```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 public IP address that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to create a public IP address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReverseFqdn -Specifies a reverse fully qualified domain name (FQDN). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -The public IP Sku name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteConfig.md deleted file mode 100644 index 57d0961f5d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteConfig.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 356764CF-A860-432A-907A-9058CEB2BF8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermrouteconfig -schema: 2.0.0 ---- - -# New-AzureRmRouteConfig - -## SYNOPSIS -Creates a route for a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteConfig [-AddressPrefix <String>] [-NextHopType <String>] [-NextHopIpAddress <String>] - [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRouteConfig** cmdlet creates a route for an Azure route table. - -## EXAMPLES - -### Example 1: Create a route -``` -PS C:\>$Route = New-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" -PS C:\> $Route -Name : Route07 -Id : -Etag : -ProvisioningState : -AddressPrefix : 10.1.0.0/16 -NextHopType : VnetLocal -NextHopIpAddress : -``` - -The first command creates a route named Route07, and then stores it in the $Route variable. -This route forwards packets to the local virtual network. - -The second command displays the properties of the route. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```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. - -```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 a name for the route. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azurevirtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: - -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azure server-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRoute - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilter.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilter.md deleted file mode 100644 index de84e250f9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilter.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutefilter -schema: 2.0.0 ---- - -# New-AzureRmRouteFilter - -## SYNOPSIS -Creates a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> -Location <String> - [-Rule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule]>] - [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRouteFilter cmdlet creates an Azure route filter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - - -{{ Add example description here }} - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet creates a route table even if a route filter that has the same name already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which this cmdlet creates a route filter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route filter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates a route filter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Rule -Specifies an array of Route Filter Rule objects to associate with the route filter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmRouteFilter](./Get-AzureRmRouteFilter.md) - -[New-AzureRmRouteFilterRuleConfig](./New-AzureRmRouteFilterRuleConfig.md) - -[Remove-AzureRmRouteFilter](./Remove-AzureRmRouteFilter.md) - -[Set-AzureRmRouteFilter](./Set-AzureRmRouteFilter.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilterRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index f4aa796b04..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutefilterruleconfig -schema: 2.0.0 ---- - -# New-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -Creates a route filter rule for a route filter. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteFilterRuleConfig [-Force] -Name <String> -Access <String> -RouteFilterRuleType <String> - -CommunityList <System.Collections.Generic.List`1[System.String]> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRouteFilterRuleConfig cmdlet creates a route filter rule for an Azure route filter. - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Access -Access for route filter rule. -Valid values are Allow or Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route filter rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -Route Filter Rule Type. -Valid values are: Community - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmRouteFilterRuleConfig](./Add-AzureRmRouteFilterRuleConfig.md) - -[Get-AzureRmRouteFilterRuleConfig](./Get-AzureRmRouteFilterRuleConfig.md) - -[Remove-AzureRmRouteFilterRuleConfig](./Remove-AzureRmRouteFilterRuleConfig.md) - -[Set-AzureRmRouteFilterRuleConfig](./Set-AzureRmRouteFilterRuleConfig.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteTable.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteTable.md deleted file mode 100644 index d394f138ce..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmRouteTable.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6A278F91-C078-4DD4-82D0-2E4FA549A089 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermroutetable -schema: 2.0.0 ---- - -# New-AzureRmRouteTable - -## SYNOPSIS -Creates a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmRouteTable -ResourceGroupName <String> -Name <String> -Location <String> [-Tag <Hashtable>] - [-Route <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRoute]>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmRouteTable** cmdlet creates an Azure route table. - -## EXAMPLES - -### Example 1: Create a route table that contains a route -``` -PS C:\>$Route = New-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.1.0.0/16 -NextHopType "VnetLocal" -PS C:\> New-AzureRmRouteTable -Name "RouteTable01" -ResourceGroupName "ResourceGroup11" -Location "EASTUS" -Route $Route -Name : routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/myroutetable -Etag : W/"db5f4e12-3f34-465b-92dd-0ab3bf6fc274" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "route07", - "Etag": "W/\"db5f4e12-3f34-465b-92dd-0ab3bf6fc274\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -The first command creates a route named Route07 by using the New-AzureRmRouteConfig cmdlet, and -then stores it in the $Route variable. This route forwards packets to the local virtual network. - -The second command creates a route table named RouteTable01, and adds the route stored in $Route to -the new table. The command specifies the resource group to which the table belongs and the location -for the table. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet creates a route table even if a route table that has the same name already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the Azure region in which this cmdlet creates a route table. -For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regions/). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the route table. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which this cmdlet creates a route table. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Route -Specifies an array of **Route** objects to associate with the route table. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSRoute] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetwork.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetwork.md deleted file mode 100644 index d41cb95c5d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 81D55C43-C9A3-4DA7-A469-A3A7550FE9A4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetwork -schema: 2.0.0 ---- - -# New-AzureRmVirtualNetwork - -## SYNOPSIS -Creates a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> -Location <String> - -AddressPrefix <System.Collections.Generic.List`1[System.String]> - [-DnsServer <System.Collections.Generic.List`1[System.String]>] - [-Subnet <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSubnet]>] - [-Tag <Hashtable>] [-EnableDDoSProtection] [-EnableVmProtection] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVirtualNetwork** cmdlet creates an Azure virtual network. - -## EXAMPLES - -### 1: Create a virtual network with two subnets -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates a virtual network with two subnets. First, a new resource group is created in -the centralus region. Then, the example creates in-memory representations of two subnets. The -New-AzureRmVirtualNetworkSubnetConfig cmdlet will not create any subnet on the server side. There -is one subnet called frontendSubnet and one subnet called backendSubnet. The -New-AzureRmVirtualNetwork cmdlet then creates a virtual network using the CIDR 10.0.0.0/16 as the -address prefix and two subnets. - -### 2: Create a virtual network with DNS settings -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -DnsServer 10.0.1.5,10.0.1.6 -``` - -This example create a virtual network with two subnets and two DNS servers. The effect of -specifying the DNS servers on the virtual network is that the NICs/VMs that are deployed into this -virtual network inherit these DNS servers as defaults. These defaults can be overwritten per NIC -through a NIC-level setting. If no DNS servers are specified on a VNET and no DNS servers on the -NICs, then the default Azure DNS servers are used for DNS resolution. - -### 3: Create a virtual network with a subnet referencing a network security group -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates a virtual network with subnets that reference a network security group. First, -the example creates a resource group as a container for the resources that will be created. Then, a -network security group is created that allows inbound RDP access, but otherwise enforces the -default network security group rules. The New-AzureRmVirtualNetworkSubnetConfig cmdlet then creates -in-memory representations of two subnets that both reference the network security group that was -created. The New-AzureRmVirtualNetwork command then creates the virtual network. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a virtual network. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsServer -Specifies the DNS server for a subnet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableDDoSProtection -A switch parameter which represents if DDoS protection is enabled or not. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableVmProtection -A switch parameter which represents if Vm protection is enabled or not. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the region for the virtual network. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet creates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group to contain the virtual network. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subnet -Specifies a list of subnets to associate with the virtual network. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSSubnet] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index b66e5e6f5a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,471 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5784FD44-91D4-4537-84F3-4F03CCBA355F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# New-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Creates a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -New-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-IpConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration]>] - [-GatewayType <String>] [-VpnType <String>] [-EnableBgp <Boolean>] [-EnableActiveActiveFeature] - [-GatewaySku <String>] [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -New-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> -Location <String> - [-IpConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration]>] - [-GatewayType <String>] [-VpnType <String>] [-EnableBgp <Boolean>] [-EnableActiveActiveFeature] - [-GatewaySku <String>] [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] -RadiusServerAddress <String> - -RadiusServerSecret <SecureString> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmVirtualNetworkGateway - [-IpConfigurations <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration]>] - [-GatewayType <String>] [-VpnType <String>] [-EnableBgp <Boolean>] [-EnableActiveActiveFeature] - [-GatewaySku <String>] [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-Tag <Hashtable>] [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. - -The **New-AzureRmVirtualNetworkGateway** cmdlet creates the object of your gateway in Azure based -on the Name, Resource Group Name, Location, and IP configuration, as well as the Gateway Type and -if VPN, the VPN Type. You can also name the Gateway SKU. - -If this Gateway is being used for Point-to-Site connections, you will also need to include the VPN -Client Address Pool from which to assign addresses to connecting clients and the VPN Client Root -Certificate used to authenticate VPN clients connecting to the Gateway. - -You can also choose to include other features like BGP and Active-Active. - -## EXAMPLES - -### 1: Create a Virtual Network Gateway -``` -New-AzureRmResourceGroup -Location "UK West" -Name "vnet-gateway" -$subnet = New-AzureRMVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' - -$ngwpip = New-AzureRMPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic -$vnet = New-AzureRmVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet -$ngwipconfig = New-AzureRMVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id - -New-AzureRmVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -``` - -The above will create a resource group, request a Public IP Address, create a Virtual Network and -subnet and create a Virtual Network Gateway in Azure. - -The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK -West" with the previously created IP configurations saved in the variable "ngwIPConfig," the -gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." - -### 2: Create a Virtual Network Gateway with External Radius Configuration -``` -New-AzureRmResourceGroup -Location "UK West" -Name "vnet-gateway" -New-AzureRMVirtualNetworkSubnetConfig -Name 'gatewaysubnet' -AddressPrefix '10.254.0.0/27' - -$ngwpip = New-AzureRMPublicIpAddress -Name ngwpip -ResourceGroupName "vnet-gateway" -Location "UK West" -AllocationMethod Dynamic -$vnet = New-AzureRmVirtualNetwork -AddressPrefix "10.254.0.0/27" -Location "UK West" -Name vnet-gateway -ResourceGroupName "vnet-gateway" -Subnet $subnet -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -name 'gatewaysubnet' -VirtualNetwork $vnet -$ngwipconfig = New-AzureRMVirtualNetworkGatewayIpConfig -Name ngwipconfig -SubnetId $subnet.Id -PublicIpAddressId $ngwpip.Id -$Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force - -New-AzureRmVirtualNetworkGateway -Name myNGW -ResourceGroupName vnet-gateway -Location "UK West" -IpConfigurations $ngwIpConfig -GatewayType "Vpn" -VpnType "RouteBased" -GatewaySku "Basic" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd -``` - -The above will create a resource group, request a Public IP Address, create a Virtual Network and -subnet and create a Virtual Network Gateway in Azure. - -The gateway will be called "myNGW" within the resource group "vnet-gateway" in the location "UK West" with the previously created IP configurations saved in the variable "ngwIPConfig," the gateway type of "VPN," the vpn type "RouteBased," and the sku "Basic." It also adds an external radius server with address "TestRadiusServer" - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -```yaml -Type: UInt32 -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. -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableActiveActiveFeature -Enables the active-active feature. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayDefaultSite -```yaml -Type: PSLocalNetworkGateway -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewaySku -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewayType -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Vpn, ExpressRoute - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IpConfigurations -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: String -Parameter Sets: Default, RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: Default, RadiusServerConfiguration -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerAddress -P2S External Radius server address. -```yaml -Type: String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. -```yaml -Type: SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: Default, RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientProtocol -The list of P2S VPN client tunneling protocols -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: SSTP, IkeV2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificates -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificates -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnType -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: PolicyBased, RouteBased - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Reset-AzureRmVirtualNetworkGateway](./Reset-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGateway](./Set-AzureRmVirtualNetworkGateway.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index 4efd824264..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0F141A92-4994-45B3-AE94-09865BC691C4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 ---- - -# New-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> - [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> - [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] - -ConnectionType <String> [-RoutingWeight <Int32>] [-SharedKey <String>] [-Peer <PSPeering>] - [-EnableBgp <Boolean>] [-Tag <Hashtable>] [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> -Location <String> - [-AuthorizationKey <String>] -VirtualNetworkGateway1 <PSVirtualNetworkGateway> - [-VirtualNetworkGateway2 <PSVirtualNetworkGateway>] [-LocalNetworkGateway2 <PSLocalNetworkGateway>] - -ConnectionType <String> [-RoutingWeight <Int32>] [-SharedKey <String>] [-PeerId <String>] - [-EnableBgp <Boolean>] [-Tag <Hashtable>] [-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -New-AzureRmVirtualNetworkGatewayConnection -Name conn-client-1 -ResourceGroupName $RG1 -VirtualNetworkGateway1 $vnetgw1 -VirtualNetworkGateway2 $vnetgw2 -Location $loc1 -ConnectionType Vnet2Vnet -SharedKey 'a1b2c3d4e5' -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthorizationKey -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionType -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPsec, Vnet2Vnet, ExpressRoute, VPNClient - -Required: True -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecPolicies -A list of IPSec policies. -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalNetworkGateway2 -```yaml -Type: PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Peer -```yaml -Type: PSPeering -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoutingWeight -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SharedKey -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: - -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UsePolicyBasedTrafficSelectors -Use policy-based traffic selectors for a S2S connection - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway1 -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway2 -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[Remove-AzureRmVirtualNetworkGatewayConnection](./Remove-AzureRmVirtualNetworkGatewayConnection.md) - -[Set-AzureRmVirtualNetworkGatewayConnection](./Set-AzureRmVirtualNetworkGatewayConnection.md) diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index 4505e96915..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C6E65138-CD14-4A54-A901-8E944201F2AE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 ---- - -# New-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS -Creates an IP Configuration for a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -New-AzureRmVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-SubnetId <String>] - [-PublicIpAddressId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -New-AzureRmVirtualNetworkGatewayIpConfig -Name <String> [-PrivateIpAddress <String>] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVirtualNetworkGatewayIpConfig** cmdlet creates a configuration assigned to a Virtual Network Gateway with a (previously created) Public IP Address based on Subnet ID. - -## EXAMPLES - -### 1: Create an IP Configuration for a Virtual Network Gateway -``` -$gwIpConfig = New-AzureRmVirtualNetworkGatewayIpConfig -Name myGWIpConfig -SubnetId $myGWsubnet.Id -PublicIpAddressId $myGWpip.Id -``` - -Configures a Virtual Network Gateway with a Public IP Address. The variable $myGWsubnet is obtained using the **Get-AzureRmVirtualNetworkSubnetConfig** cmdlet on the "GatewaySubnet" within the Virtual Network you intend to create a Virtual Network Gateway. The variable $myGWpip is obtained using the **New-AzureRmPublicIpAddress** cmdlet. - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayIpConfiguration - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index 9ebcb21dab..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 901FD38B-67FA-40D5-8D23-51E5544C25D8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvirtualnetworksubnetconfig -schema: 2.0.0 ---- - -# New-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Creates a virtual network subnet configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -New-AzureRmVirtualNetworkSubnetConfig -Name <String> -AddressPrefix <String> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -New-AzureRmVirtualNetworkSubnetConfig -Name <String> -AddressPrefix <String> [-NetworkSecurityGroupId <String>] - [-RouteTableId <String>] [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The New-AzureRmVirtualNetworkSubnetConfig** cmdlet creates a virtual network subnet configuration. - -## EXAMPLES - -### 1: Create a virtual network with two subnets and a network security group -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" ` - -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 ` - -SourceAddressPrefix Internet -SourcePortRange * ` - -DestinationAddressPrefix * -DestinationPortRange 3389 - -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName TestResourceGroup ` - -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet ` - -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup - -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet ` - -AddressPrefix "10.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup - -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup ` - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet -``` - -This example creates two new subnet configurations using the - New-AzureRmVirtualSubnetConfig cmdlet, and then uses them to create a virtual network. - The New-AzureRmVirtualSubnetConfig template only creates an in-memory representation of - the subnet. In this example, the frontendSubnet has CIDR 10.0.1.0/24 and references a - network security group that allows RDP access. The backendSubnet has CIDR 10.0.2.0/24 and - references the same network security group. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 subnet configuration to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a NetworkSecurityGroup object. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table associated with the subnet configuration. - -```yaml -Type: PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -Specifies the ID of the route table associated with the subnet configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSSubnet - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientConfiguration.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientConfiguration.md deleted file mode 100644 index 6424365934..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientConfiguration.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientconfiguration -schema: 2.0.0 ---- - -# New-AzureRmVpnClientConfiguration - -## SYNOPSIS -This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientConfiguration [-Name <String>] -ResourceGroupName <String> - [-ProcessorArchitecture <String>] -AuthenticationMethod <String> [-RadiusRootCertificateFile <String>] - [-ClientRootCertificateFileList <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -this allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional settings that users may need to configure, for e.g. some root certificates. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmVpnClientConfiguration -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup" -AuthenticationMethod "EAPTLS" -RadiusRootCert "C:\Users\Test\Desktop\VpnProfileRadiusCert.cer" -``` - -This cmdlet is used to create a VPN client profile zip file for "ContosoVirtualNetworkGateway" in ResourceGroup "ContosoResourceGroup". The profile is generated for a pre-configured radius server that is configured to use "EAPTLS" authentication method with the VpnProfileRadiusCert certificate file. - -## PARAMETERS - -### -AuthenticationMethod -Authentication Method -Can take values EAPMSCHAPv2 or EAPTLS. When EAPMSCHAPv2 is specified then the cmdlet generates a client configuration installer for username/password authentication that uses EAP-MSCHAPv2 authentication protocol. If EAPTLS is specified then the cmdlet generates a client configuration installer for certificate authentication that uses EAP-TLS protocol. The "EapTls" option can be used for both RADIUS-based certificate authentication and certification authentication performed by the Virtual Network Gateway by uploading the trusted root. The cmdlet automatically detects what is configured. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: EAPTLS, EAPMSCHAPv2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientRootCertificateFileList -A list of client root certificate paths -```yaml -Type: System.Collections.Generic.List`1[System.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. -```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 resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProcessorArchitecture -ProcessorArchitecture - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Amd64, X86 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusRootCertificateFile -Radius server root certificate path. This is a mandatory parameter that has to be specified when EAP-TLS with RADIUS authentication is used. This is the full path name of .cer file containing the RADIUS root certificate that the client uses to validates the RADIUS server during authentication. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVpnProfile - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRevokedCertificate.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index 6109b6d070..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 973E1E53-983F-45A7-A7CF-18A8D96EC4E6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientrevokedcertificate -schema: 2.0.0 ---- - -# New-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Creates a new VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientRevokedCertificate -Name <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVpnClientRevokedCertificate** cmdlet creates a new virtual private network (VPN) client-revocation certificate for use on a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. - -This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. -Instead, the certificate created by **New-AzureRmVpnClientRevokedCertificate** is used in conjunction with the New-AzureRmVirtualNetworkGateway cmdlet when it creates a new gateway. -For instance, suppose you create a new certificate and store it in a variable named $Certificate. -You can then use that certificate object when you create a new virtual gateway. -For instance, - -`New-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRevokedCertificates $Certificate` - -For more information, see the documentation for the New-AzureRmVirtualNetworkGateway cmdlet. - -## EXAMPLES - -### Example 1: Create a new client-revoked certificate -``` -PS C:\>$Certificate = New-AzureRmVpnClientRevokedCertificate -Name "ContosoClientRevokedCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command creates a new client-revoked certificate and stores the certificate object in a variable named $Certificate. -This variable can then be used by the **New-AzureRmVirtualNetworkGateway** cmdlet to add the certificate to a new virtual network gateway. - -## 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 -Specifies a unique name for the new client-revocation certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being added. - -You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: - -`Get-ChildItem -Path Cert:\LocalMachine\Root` - -The preceding command returns information for all the Local Computer certificates found in the Root certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet does not accept pipelined input. - -## OUTPUTS - -### -This cmdlet creates new instances of the **Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[Remove-AzureRmVpnClientRevokedCertificate](./Remove-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRootCertificate.md b/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index 18795046ce..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/New-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C54AC64C-DA21-443E-8CFE-6CCAC6152C2B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/new-azurermvpnclientrootcertificate -schema: 2.0.0 ---- - -# New-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Creates a new VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmVpnClientRootCertificate -Name <String> -PublicCertData <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmVpnClientRootCertificate** cmdlet creates a new VPN root certificate for use on a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. - -This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. -Instead, the certificate created by **New-AzureRmVpnClientRootCertificate** is used in conjunction with the New-AzureRmVirtualNetworkGateway cmdlet when creating a new gateway. -For example, suppose you create a new certificate and store it in a variable named $Certificate. -You can then use that certificate object when creating a new virtual gateway. -For instance, - -`New-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRootCertificates $Certificate` - -For more information, see the documentation for the New-AzureRmVirtualNetworkGateway cmdlet. - -## EXAMPLES - -### Example 1: Create aclient root certificate -``` -PS C:\> $Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> $Certificate = New-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -Name "ContosoClientRootCertificate" -``` - -This example creates a client root certificate and store the certificate object in a variable named $Certificate. -This variable can then be used by the **New-AzureRmVirtualNetworkGateway** cmdlet to add a root certificate to a new virtual network gateway. - -The first command uses the **Get-Content** cmdlet to get a previously exported text representation of the root certificate; that text data is stored in a variable named $Text. - -The second command then uses a for loop to extract all the text except for the first line and the last line, storing the extracted text in a variable named $CertificateText. - -The third command uses the **New-AzureRmVpnClientRootCertificate** cmdlet to create the certificate, storing the created object in a variable named $Certificate. - -## 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 -Specifies a name for the new client root certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCertData -Specifies a text representation of the root certificate to be added. -To obtain the text representation, export your certificate in .cer format (using Base64 encoding), then open the resulting file in a text editor. -You should see output similar to this (note that the actual output will contain many more lines of text than the abbreviated sample shown here): - ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- - -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve the PublicCertData by using Windows PowerShell commands similar to this: - -$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet does not accept pipelined input. - -## OUTPUTS - -### -This cmdlet creates new instances of the **Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[Remove-AzureRmVpnClientRootCertificate](./Remove-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGateway.md deleted file mode 100644 index e88bb9a602..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGateway.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E9390015-FD5C-4015-BA81-3445ADF8F8BF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgateway -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGateway - -## SYNOPSIS -Removes an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGateway** cmdlet removes an application gateway. - -## EXAMPLES - -### Example 1: Remove a specified application gateway -``` -PS C:\>Remove-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -``` - -This command removes the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01. - -## 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 -Indicates that the cmdlet forces the deletion of the application gateway regardless of whether resources are assigned to it. - -```yaml -Type: SwitchParameter -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 application gateway to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group name that the application gateway belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Set-AzureRmApplicationGateway](./Set-AzureRmApplicationGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 06650a1cc1..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 29BB24C4-1EC9-47DE-A5B8-5EEA4525AE3A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Removes an authentication certificate from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayAuthenticationCertificate -Name <String> - -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet removes an authentication certificate from an Azure application gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway from which this cmdlet removes an authentication certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the authentication certificate that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Set-AzureRmApplicationGatewayAuthenticationCertificate](./Set-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index a4ed3b101b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F34C5D18-C505-4815-9DDB-C563E205515C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Removes a back-end address pool from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayBackendAddressPool -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayBackendAddressPool** cmdlet removes a back-end address pool from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a back-end address pool from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "BackEndPool02" -``` - -The first command gets the application gateway named ApplicationGateway01 belonging to the resource group named ResourceGroup01 and saves it in the $AppGw variable. - -The second command removes the back-end address pool named BackEndPool02 from the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes a back-end address pool. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the back-end address pool that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Set-AzureRmApplicationGatewayBackendAddressPool](./Set-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index d9fdda5adc..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Removes back-end HTTP settings from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayBackendHttpSettings -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewayBackendHttpSettings cmdlet removes back-end Hypertext Transfer Protocol (HTTP) settings from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove back-end HTTP settings from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "BackEndSetting02" -``` - -The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -The second command removes the back-end HTTP setting named BackEndSetting02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes back-end HTTP settings. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the back-end HTTP settings that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[Set-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index 4d3875f75c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Removes the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayConnectionDraining - -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayConnectionDraining** cmdlet removes the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> Remove-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $Settings -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command removes the connection draining configuration of the back-end HTTP settings stored in $Settings. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Set-AzureRmApplicationGatewayConnectionDraining](./Set-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index b9e2a70c2b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 289B761C-1A1D-46D2-8755-B6B6A4758EFC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Removes a front-end IP configuration from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayFrontendIPConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayFrontendIPConfig** cmdlet removes frontend IP from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a front-end IP configuration -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIP02" -``` - -The first command gets an application gateway named ApplicationGateway01 and stores it in the $AppGw variable. - -The second command removes the front-end IP configuration named FrontEndIP02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway from which to remove a front-end IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of a front-end IP configuration to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Set-AzureRmApplicationGatewayFrontendIPConfig](./Set-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendPort.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 7187d5f215..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A698954A-994E-45AD-BA36-1E03196CFCB0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayfrontendport -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Removes a front-end port from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayFrontendPort -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayFrontendPort** cmdlet removes a front-end port from an Azure application gateway. - -## EXAMPLES - -### Example: Remove a front-end port from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort02" -``` - -The first command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores the gateway in $AppGw variable. - -The second command removes the port named FrontEndPort02 from the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove a front-end port. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies name of the frontend port to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Set-AzureRmApplicationGatewayFrontendPort](./Set-AzureRmApplicationGatewayFrontendPort.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayHttpListener.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index e9bb5a84ac..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6C90AF6C-3193-4D75-A78F-3EC315C6D7DF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayhttplistener -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Removes an HTTP listener from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayHttpListener -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayHttpListener** cmdlet removes an HTTP listener from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an application gateway HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. - -The second command removes the HTTP listener named Listener02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove an HTTP listener. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the HTTP listener that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayHttpListener - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Set-AzureRmApplicationGatewayHttpListener](./Set-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 421a5c7b16..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6943BB5C-D709-4A80-AF5E-DC9501C20680 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayipconfiguration -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Removes an IP configuration from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayIPConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayIPConfiguration** cmdlet removes an IP configuration from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an IP configuration from an Azure application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "Subnet02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. - -The second command removes the IP configuration named Subnet02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove an IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the IP configuration to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Set-AzureRmApplicationGatewayIPConfiguration](./Set-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 7db3472e3d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayprobeconfig -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Removes a health probe from an existing application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayProbeConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewayProbeConfig cmdlet removes a heath probe from an existing application gateway. - -## EXAMPLES - -### Example 1: Remove a health probe from an existing application gateway -``` -PS C:\>$Gateway = Remove-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe04" -``` - -This command removes the health probe named Probe04 from the application gateway named Gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet removes a probe. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the probe for which this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Remove a probe from an existing application gateway](https://azure.microsoft.com/en-us/documentation/articles/application-gateway-create-probe-ps/#remove-a-probe-from-an-existing-application-gateway) - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Set-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 7b4d5eb315..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Removes a redirect configuration from an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayRedirectConfiguration -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayRedirectConfiguration** cmdlet removes a redirect configuration from an existing Application Gateway. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\>$AppGw = Remove-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $AppGw -Name "Redirect01" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. - -The second command removes the redirect configuration named Redirect01 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -The name of the redirect configuration - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 8536bdf101..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: CC033DA8-FACC-44E2-82F9-E30FADBF8926 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Removes a request routing rule from an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayRequestRoutingRule -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayRequestRoutingRule** cmdlet removes a request routing rule from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove a request routing rule from an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule02" -``` - -The first command gets an application gateway and stores it in the $AppGw variable. - -The second command removes the request routing rule named Rule02 from the application gateway stored in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which to remove a request routing rule. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the request routing rule for which this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayRequestRoutingRule - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Set-AzureRmApplicationGatewayRequestRoutingRule](./Set-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslCertificate.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index 692ccbc0c2..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D788B84-0179-4A35-AC35-27C6F5FECB39 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaysslcertificate -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Removes an SSL certificate from an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewaySslCertificate -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewaySslCertificate** cmdlet removes a Secure Sockets Layer (SSL) certificate from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an SSL certificate from an application gateway -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Remove-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert02" -``` - -The first command gets the application gateway named ApplicationGateway01 and stores the result in the variable named $AppGW. - -The second command removes the SSL certificate named Cert02 from the application gateway stored in the $AppGW variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes an SSL certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of an SSL certificate that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Set-AzureRmApplicationGatewaySslCertificate](./Set-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslPolicy.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 49c1559d30..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A308E4DD-49FA-4905-94A7-CEA3AAEC3959 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewaysslpolicy -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Removes an SSL policy from an Azure application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmApplicationGatewaySslPolicy cmdlet removes SSL policy from an Azure application gateway. - -## EXAMPLES - -### Example 1: Remove an SSL policy from an application gateway -``` -PS C:\>$AppGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGW = Remove-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $AppGW -``` - -This command removes the SSL policy from the application gateway named ApplicationGateway01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway from which this cmdlet removes SSL policy. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Set-AzureRmApplicationGatewaySslPolicy](./Set-AzureRmApplicationGatewaySslPolicy.md) - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index 4582d9488f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: E43C8D2A-A6B5-4259-94B9-353FBC15F5A8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Removes URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationGatewayUrlPathMapConfig -Name <String> -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet removes URL path mappings to a backend server pool. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet removes URL path map configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the URL path map name that this cmdlet removes from the backend server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationSecurityGroup.md deleted file mode 100644 index 11d0c9f258..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmApplicationSecurityGroup.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermapplicationsecuritygroup -schema: 2.0.0 ---- - -# Remove-AzureRmApplicationSecurityGroup - -## SYNOPSIS -Removes an application security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmApplicationSecurityGroup -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmApplicationSecurityGroup** cmdlet removes an application security group. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-AzureRmApplicationSecurityGroup -Name "MyApplicationSecurityGrouo" -ResourceGroupName "MyResourceGroup" -``` - -This command deletes an application security group named MyApplicationSecurityGrouo in the resource group named MyResourceGroup. - -## 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 -Do not ask for confirmation if you want to delete resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the application security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name of the application security group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-AzureRmApplicationSecurityGroup](./New-AzureRmApplicationSecurityGroup.md) - -[Get-AzureRmApplicationSecurityGroup](./Get-AzureRmApplicationSecurityGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuit.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuit.md deleted file mode 100644 index 36ff950782..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EDB94194-650C-4892-8DDC-E67D435522DD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuit -schema: 2.0.0 ---- - -# Remove-AzureRmExpressRouteCircuit - -## SYNOPSIS -Removes an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuit -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuit** cmdlet removes an ExpressRoute circuit. - -## EXAMPLES - -### Example 1: Delete an ExpressRoute circuit -``` -Remove-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -``` - -### Example 2: Delete an ExpressRoute circuit using the pipeline -``` -Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzureRmExpressRouteCircuit -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the ExpressRoute circuit to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that this ExpressRoute circuit belongs to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](New-AzureRmExpressRouteCircuit.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md deleted file mode 100644 index 8ccdade139..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitAuthorization.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 38D57CE4-6994-4BDA-A50E-28680EF4E568 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuitauthorization -schema: 2.0.0 ---- - -# Remove-AzureRmExpressRouteCircuitAuthorization - -## SYNOPSIS -Removes an existing ExpressRoute configuration authorization. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuitAuthorization [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuitAuthorization** cmdlet removes an authorization assigned to -an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to Azure by using a -connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can -create as many as 10 authorizations for each circuit; these authorizations generate an -authorization key that can be used by a virtual network owner to connect his or her network to the -circuit. There can only be one authorization per virtual network. At any time, however, the circuit -owner can use **Remove-AzureRmExpressRouteCircuitAuthorization** to remove the authorization -assigned to a virtual network. When that happens the corresponding virtual network is no longer -able to use the ExpressRoute circuit to connect to Azure. - -## EXAMPLES - -### Example 1: Remove a circuit authorization from an ExpressRoute circuit -``` -$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup" -Remove-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit -``` - -This example removes a circuit authorization from an ExpressRoute circuit. The first command uses -the **Get-AzureRmExpressRouteCircuit** cmdlet to create an object reference to an ExpressRoute -circuit named ContosoCircuit and stores the result in the variable named $Circuit. - -The second command marks the circuit authorization ContosoCircuitAuthorization for removal. - -The third command uses the Set-AzureRmExpressRouteCircuit cmdlet to confirm the removal of the -ExpressRoute circuit stored in the $Circuit variable. - -## 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 -``` - -### -ExpressRouteCircuit -Specifies the ExpressRouteCircuit object that this cmdlet removes. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the circuit authorization that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -This cmdlet accepts pipelined instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object. - -## OUTPUTS - -### PSExpressRouteCircuit -This cmdlet modifies existing instances of the -**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object. - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitAuthorization](./Add-AzureRmExpressRouteCircuitAuthorization.md) - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md) - -[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md) - -[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index 5b3a835edb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 462F3EF7-4C15-41F8-853D-CDCC8E67673D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 ---- - -# Remove-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Removes an ExpressRoute circuit peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmExpressRouteCircuitPeeringConfig [-Name <String>] -ExpressRouteCircuit <PSExpressRouteCircuit> - [-PeerAddressType <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmExpressRouteCircuitPeeringConfig** cmdlet removes an ExpressRoute circuit -peering configuration. - -## EXAMPLES - -### Example 1: Remove a peering configuration from an ExpressRoute circuit -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -Remove-AzureRmExpressRouteCircuitPeeringConfig -Name 'AzurePrivatePeering' -ExpressRouteCircuit $circuit -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## 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 -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit containing the peering configuration to be removed. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -The Address family of the peering - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6, All - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Set-AzureRmExpressRouteCircuit](Set-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancer.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancer.md deleted file mode 100644 index 93320ef409..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancer.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 31B0FBEF-366A-41AF-9182-2EB087019F36 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancer -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancer - -## SYNOPSIS -Removes a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancer -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancer** cmdlet removes an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a load balancer -``` -PS C:\>Remove-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -``` - -This command deletes a load balancer named MyLoadBalancer in the resource group named MyResourceGroup. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that this cmdlet removes the load balancer regardless of whether resources are assigned to it. - -```yaml -Type: SwitchParameter -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 load balancer to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 load balancer to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Set-AzureRmLoadBalancer](./Set-AzureRmLoadBalancer.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md deleted file mode 100644 index 7f2ed1ae71..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerBackendAddressPoolConfig.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F965A9DE-645C-471B-84E8-58D648B1CA57 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerbackendaddresspoolconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerBackendAddressPoolConfig - -## SYNOPSIS -Removes a backend address pool configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerBackendAddressPoolConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerBackendAddressPoolConfig** cmdlet removes a backend address pool from a load balancer. - -## EXAMPLES - -### Example 1: Remove a backend address pool configuration from a load balancer -``` -PS C:\>Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" | Remove-AzureRmLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool02" | Set-AzureRmLoadBalancer -``` - -This command gets the load balancer named MyLoadBalancer and passes it to **Remove-AzureRmLoadBalancerBackendAddressPoolConfig**, which removes the BackendAddressPool02 configuration from MyLoadBalancer. -Finally, the Set-AzureRmLoadBalancer cmdlet updates MyLoadBalancer. -Note that a backend address pool configuration must exist before you can delete it. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that contains the backend address pool to remove. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the backend address pool that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerBackendAddressPoolConfig](./Add-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerBackendAddressPoolConfig](./Get-AzureRmLoadBalancerBackendAddressPoolConfig.md) - -[New-AzureRmLoadBalancerBackendAddressPoolConfig](./New-AzureRmLoadBalancerBackendAddressPoolConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 7b2c2245f9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5F8E11DF-D560-44D7-99CA-C425951A56D6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerfrontendipconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Removes a front-end IP configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerFrontendIpConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerFrontendIpConfig** cmdlet removes a front-end IP configuration from an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a front-end IP configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerFrontendIpConfig -Name "frontendName" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer that is associated with the front-end IP configuration you want to remove, and then stores it in the $loadbalancer variable. - -The second command removes the associated frontend IP configuration from the load balancer in $loadbalancer. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that contains the front-end IP configuration to remove. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP address configuration to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Set-AzureRmLoadBalancerFrontendIpConfig](./Set-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index 54118db906..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 98D2EB70-440F-45C4-A79A-EB87BBDC6256 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerInboundNatPoolConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## 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 -``` - -### -LoadBalancer -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index a87de2d3f8..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D818C404-60E4-42DB-AADF-063305D9541B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Removes an inbound NAT rule configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerInboundNatRuleConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet removes an inbound network address translation (NAT) rule configuration from an Azure load balancer. - -## EXAMPLES - -### 1: Delete an inbound NAT rule from an Azure load balancer -``` -$loadbalancer = Get-AzureRmLoadBalancer -Name mylb -ResourceGroupName myrg - - Remove-AzureRmLoadBalancerInboundNatRuleConfig -Name "myinboundnatrule" -LoadBalancer $loadbalancer -``` - -The first command loads an already existing load balancer called "mylb" and stores it in the variable $load - balancer. The second command removes the inbound NAT rule associated with this load balancer. - -## 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 -``` - -### -LoadBalancer -Specifies the **LoadBalancer** object that contains the inbound NAT rule configuration that this cmdlet removes. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the inbound NAT rule configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Set-AzureRmLoadBalancerInboundNatRuleConfig](./Set-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 9b34a0f38e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2B15B224-E36C-454B-B6C2-F2BE032AE962 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerprobeconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Removes a probe configuration from a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerProbeConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerProbeConfig** cmdlet removes a probe configuration from a load balancer. - -## EXAMPLES - -### Example 1: Remove a probe configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerProbeConfig -Name "MyProbe" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. - -The second command deletes the configuration named MyProbe from the load balancer in $loadbalancer. - -## 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 -``` - -### -LoadBalancer -Specifies the load balancer that contains the probe configuration that this cmdlet removes. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Set-AzureRmLoadBalancerProbeConfig](./Set-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index e3be0ef281..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DEBD58A3-AFAF-485C-8708-53228625138F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermloadbalancerruleconfig -schema: 2.0.0 ---- - -# Remove-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Removes a rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLoadBalancerRuleConfig [-Name <String>] -LoadBalancer <PSLoadBalancer> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmLoadBalancerRuleConfig** cmdlet removes a rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Remove a rule configuration from a load balancer -``` -PS C:\>$loadbalancer = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:> Remove-AzureRmLoadBalancerRuleConfig -Name "MyLBruleName" -LoadBalancer $loadbalancer -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $loadbalancer variable. - -The second command removes the rule configuration named MyLBruleName from the load balancer in $loadbalancer. - -## 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 -``` - -### -LoadBalancer -Specifies the **LoadBalancer** object that contains the rule configuration that this cmdlet removes. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the load balancer rule configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Set-AzureRmLoadBalancerRuleConfig](./Set-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLocalNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLocalNetworkGateway.md deleted file mode 100644 index 91f464fc1c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 75E30205-97AD-44E3-A61F-62B81ADB532C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermlocalnetworkgateway -schema: 2.0.0 ---- - -# Remove-AzureRmLocalNetworkGateway - -## SYNOPSIS -Deletes a Local Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmLocalNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Local Network Gateway is the object representing your VPN device On-Premises. - -The **Remove-AzureRmLocalNetworkGateway** cmdlet deletes the object representing your on-prem gateway based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Local Network Gateway -``` -Remove-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG -``` - -Deletes the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG" - -Note: You must first delete all connections to the Local Network Gateway using the **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the local network gateway that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 local network gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[New-AzureRmLocalNetworkGateway](./New-AzureRmLocalNetworkGateway.md) - -[Set-AzureRmLocalNetworkGateway](./Set-AzureRmLocalNetworkGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterface.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterface.md deleted file mode 100644 index a98779c743..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterface.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C83A0465-45EF-4FCC-B706-D5DF819664F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkinterface -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkInterface - -## SYNOPSIS -Removes a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkInterface -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkInterface** cmdlet removes an Azure network interface. - -## EXAMPLES - -### Example 1: Remove a network interface -``` -PS C:\>Remove-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroup "ResourceGroup1" -``` - -This command removes the network interface NetworkInterface1 in resource group ResourceGroup1. -Because the *Force* parameter is not used, the user will be prompted to confirm this action. - -### Example 2: Remove a network interface -``` -PS C:\>Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" | Remove-AzureRmNetworkInterface -Force -``` - -This command removes all network interfaces in resource group ResourceGroup1. -Because the *Force* parameter is used, the user is not prompted for confirmation. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network interface that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that contains the network interface that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Set-AzureRmNetworkInterface](./Set-AzureRmNetworkInterface.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterfaceIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index f3929778db..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 015C7DB7-2B08-4033-9B6E-1738D4DDACDA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkinterfaceipconfig -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Removes a network interface IP configuration from a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkInterfaceIpConfig** cmdlet removes a network interface IP configuration from an Azure network interface. - -## EXAMPLES - -### 1: Delete an IP configuration from a network interface -``` -$nic = Get-AzureRmNetworkInterface -Name mynic -ResourceGroupName myrg - -Remove-AzureRmNetworkInterfaceIpConfig -Name IPConfig-1 -NetworkInterface $nic -``` - -The first command gets a network interface called mynic and stores it in the variable $nic. The second command - removes the IP configuration called IPConfig-1 associated with this network interface. - -## 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 -Specifies the name of the network interface IP configuration to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This object contains the network interface IP configuration to remove. - -```yaml -Type: PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkInterface -Parameter 'NetworkInterface' accepts value of type 'PSNetworkInterface' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Set-AzureRmNetworkInterfaceIpConfig](./Set-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index 589d812b22..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 01F56553-1685-43D4-89E6-DDCDF17D1E00 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworksecuritygroup -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Removes a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkSecurityGroup -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkSecurityGroup** cmdlet removes an Azure network security group. - -## EXAMPLES - -### Example 1: Remove a network security group -``` -PS C:\>Remove-AzureRmNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" -``` - -This command removes the security group named NSG-FrontEnd in the resource group named TestRG. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security group that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group that this cmdlet removes a network security group from. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Set-AzureRmNetworkSecurityGroup](./Set-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index a9aa010908..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2E43D0D8-EF93-443B-AA8F-58C992026E95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworksecurityruleconfig -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Removes a network security rule from a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkSecurityRuleConfig [-Name <String>] -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmNetworkSecurityRuleConfig** cmdlet removes a network security rule configuration from an Azure network security group. - -## EXAMPLES - -### Example 1: Remove a network security rule configuration -``` -PS C:\>$rule1 = New-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 -PS C:\> $nsg = New-AzureRmNetworkSecurityGroup -ResourceGroupName "TestRG" -Location "westus" -Name "NSG-FrontEnd" -SecurityRules $rule1 -PS C:\> Remove-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg -``` - -The first command creates a network security rule configuration named rdp-rule, and then stores it in the $rule1 variable. - -The second command creates a network security group using the rule in $rule1, and then stores the network security group in the $nsg variable. - -The third command removes the network security rule configuration named rdp-rule from the network security group in $nsg. - -## 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 -Specifies the name of the network security rule configuration that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. -This object contains the network security rule configuration to remove. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkSecurityGroup -Parameter 'NetworkSecurityGroup' accepts value of type 'PSNetworkSecurityGroup' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Set-AzureRmNetworkSecurityRuleConfig](./Set-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcher.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcher.md deleted file mode 100644 index 44078bac61..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcher.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcher -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkWatcher - -## SYNOPSIS -Removes a Network Watcher. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmNetworkWatcher -Name <String> -ResourceGroupName <String> [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmNetworkWatcher cmdlet removes a Network Watcher resource. - -## EXAMPLES - -### -------------------------- Example 1: Create and delete a Network Watcher -------------------------- -``` -New-AzureRmResourceGroup -Name NetworkWatcherRG -Location westcentralus -New-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -Location westcentralus -Remove-AzureRmNetworkWatcher -Name NetworkWatcher_westcentralus -ResourceGroup NetworkWatcherRG -``` - -This example creates a Network Watcher in a resource group and then immediately deletes it. Note that only one Network Watcher can be created per region per subscription. -To suppress the prompt when deleting the virtual network, use the -Force flag. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index ef8342f4ab..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcher -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Remove connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByName -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByLocation -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByResourceId -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByInputObject -``` -Remove-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-Name <String>] - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -The remove-AzureRmNetworkWatcherConnectionMonitor cmdlet removes the specified connection monitor. - -## EXAMPLES - -### --------------- Example 1: Remove the specified connection monitor --------------- -``` -PS C:\> Remove-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -``` - -In this example we delete the connection monitor specified by location and name. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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 -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## OUTPUTS - -### System.Boolean - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherPacketCapture.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index a560b7dfd9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermnetworkwatcherpacketcapture -schema: 2.0.0 ---- - -# Remove-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Removes a packet capture resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmNetworkWatcherPacketCapture removes a packet capture resource. -It is recommended to call Stop-AzureRmNetworkWatcherPacketCapture before calling Remove-AzureRmNetworkWatcherPacketCapture. -If the packet capture session is running when Remove-AzureRmNetworkWatcherPacketCapture is called the packet capture may not be saved. If the session is stopped prior to removal the .cap file containing capture data is not removed. - -## EXAMPLES - -### --- Example 1: Remove a packet capture session -- -``` -Remove-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we remove an existing packet capture session named "PacketCaptureTest". - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### System.Object - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic, remove - -## RELATED LINKS - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmPublicIpAddress.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmPublicIpAddress.md deleted file mode 100644 index b731ce532d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 00236BC2-61D8-49C2-91BE-923C567153F3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermpublicipaddress -schema: 2.0.0 ---- - -# Remove-AzureRmPublicIpAddress - -## SYNOPSIS -Removes a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmPublicIpAddress -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPublicIpAddress** cmdlet removes an Azure public IP address. - -## EXAMPLES - -### 1: Remove a public IP address resource -``` -Remove-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - -This command removes the public IP address resource named $publicIpName in the resource group $rgName. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the public IP address that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 public IP address that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Set-AzureRmPublicIpAddress](./Set-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteConfig.md deleted file mode 100644 index 9d08119b96..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteConfig.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 03285628-6BD3-4F2F-8129-E3CAE4C70EC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermrouteconfig -schema: 2.0.0 ---- - -# Remove-AzureRmRouteConfig - -## SYNOPSIS -Removes a route from a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteConfig -RouteTable <PSRouteTable> [-Name <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRouteConfig** cmdlet removes a route from an Azure route table. - -## EXAMPLES - -### Example 1: Remove a route -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Remove-AzureRmRouteConfig -Name "Route02" | Set-AzureRmRouteTable -Name : RouteTable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"47099b62-60ec-4bc1-b87b-fad56cb8bed1" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"47099b62-60ec-4bc1-b87b-fad56cb8bed1\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using the **Get-AzureRmRouteTable** cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet remove the route named Route02, and the passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. -The table no longer contains the route named Route02. - -## 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 -Specifies the name of the route that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table that contains the route that this cmdlet deletes. - -```yaml -Type: PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteTable -Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Set-AzureRmRouteConfig](./Set-AzureRmRouteConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilter.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilter.md deleted file mode 100644 index a2206bbeb9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilter.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutefilter -schema: 2.0.0 ---- - -# Remove-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteFilter -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description 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 -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The resource name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilterRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index bbf9d2aae7..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutefilterruleconfig -schema: 2.0.0 ---- - -# Remove-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteFilterRuleConfig -Name <String> -RouteFilter <PSRouteFilter> [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description 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 -Do not ask for confirmation if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the route filter rule - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilterRule - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteTable.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteTable.md deleted file mode 100644 index e02166c664..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmRouteTable.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: FDA33633-EB2E-4095-8498-DF8910F1D434 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermroutetable -schema: 2.0.0 ---- - -# Remove-AzureRmRouteTable - -## SYNOPSIS -Removes a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmRouteTable -ResourceGroupName <String> -Name <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmRouteTable** cmdlet removes an Azure route table. - -## EXAMPLES - -### Example 1: Remove a route table -``` -PS C:\>Remove-AzureRmRouteTable -ResourceGroupName "ResourceGroup11 -Name "RouteTable01" -Confirm -Are you sure you want to remove resource 'RouteTable01' -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y -``` - -This command removes the route table named RouteTable01 in the resource group named ResourceGroup11. -The cmdlet prompts you for confirmation before it removes the table. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the route table that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 route table that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Set-AzureRmRouteTable](./Set-AzureRmRouteTable.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetwork.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetwork.md deleted file mode 100644 index 2a9a42a9a2..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C48E204D-D7EC-4EFD-ADC5-C6F593313B9B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetwork -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetwork - -## SYNOPSIS -Removes a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetwork -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetwork** cmdlet removes an Azure virtual network. - -## EXAMPLES - -### 1: Create and delete a virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - $backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix - "10.0.2.0/24" - -New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet - -Remove-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -``` - -This example creates a virtual network in a resource group and then immediately deletes it. To suppress the prompt when deleting the virtual network, use the -Force flag. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 virtual network that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Set-AzureRmVirtualNetwork](./Set-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index f5c553b8a3..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A35BB728-A7EF-4ADF-B1A9-25A156434E99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Deletes a Virtual Network Gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGateway -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway is the object representing your gateway in Azure. - -The **Get-AzureRmVirtualNetworkGateway** cmdlet returns the object of your gateway in Azure based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Virtual Network Gateway -``` -Remove-AzureRmVirtualNetworkGateway -Name myGateway -ResourceGroupName myRG -``` - -Deletes the object of the Virtual Network Gateway with the name "myGateway" within the resource group "myRG" - -Note: You must first delete all connections to the Virtual Network Gateway using the **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 virtual network gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index f9d829b729..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 15958F3D-291A-4E49-A667-9792E9A1577A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Deletes a Virtual Network Gateway Connection - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Virtual Network Gateway Connection is the object representing the IPsec tunnel (Site-to-Site or Vnet-to-Vnet) connected to your Virtual Network Gateway in Azure. - -The **Remove-AzureRmVirtualNetworkGatewayConnection** cmdlet deletes the object of your connection based on Name and Resource Group Name. - -## EXAMPLES - -### 1: Delete a Virtual Network Gateway Connection -``` -Remove-AzureRmVirtualNetworkGatewayConnection -Name myTunnel -ResourceGroupName myRG -``` - -Deletes the object of the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG" - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway connection that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 virtual network gateway connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[New-AzureRmVirtualNetworkGatewayConnection](./New-AzureRmVirtualNetworkGatewayConnection.md) - -[Set-AzureRmVirtualNetworkGatewayConnection](./Set-AzureRmVirtualNetworkGatewayConnection.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md deleted file mode 100644 index 1552b76a67..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayDefaultSite.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 65E9C4D5-4D2C-4039-A87B-4E693B97C4CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewaydefaultsite -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkGatewayDefaultSite - -## SYNOPSIS -Removes the default site from a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet removes the forced tunneling default site from a virtual network gateway. -Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. -Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. - -**Remove-AzureRmVirtualNetworkGatewayDefaultSite** removes the default site assigned to a gateway. -If you do this you will need to use Set-AzureRmVirtualNetworkGatewayDefaultSite to assign a new default site before the gateway can be used for forced tunneling. - -## EXAMPLES - -### Example 1: Remove the default site assigned to a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Remove-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworknGateway $Gateway -``` - -This example removes the default site currently assigned to a virtual network gateway named ContosoVirtualGateway. - -The first command uses **Get-AzureRmVirtualNetworkGateway** to create an object reference to the gateway; this object reference is stored in a variable named $Gateway. - -The second command then uses **Remove-AzureRmVirtualNetworkGatewayDefaultSite** to remove the default site assigned to that gateway. - -## 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 -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway containing the default site to be removed. -You can create an object reference to a virtual network gateway by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet accepts pipelined instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## OUTPUTS - -### -This cmdlet modifies existing instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayDefaultSite](./Set-AzureRmVirtualNetworkGatewayDefaultSite.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md deleted file mode 100644 index c853bc67f7..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkGatewayIpConfig.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 60DA2175-7970-410C-A13C-B1314716AD8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkgatewayipconfig -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkGatewayIpConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkGatewayIpConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## 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 -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetworkGateway -Parameter 'VirtualNetworkGateway' accepts value of type 'PSVirtualNetworkGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkPeering.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index 9c28a95b8a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1CE08F0F-A59E-46AC-B470-F1DCCD46513E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworkpeering -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkPeering - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkPeering -VirtualNetworkName <String> -Name <String> -ResourceGroupName <String> - [-Force] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1: Remove a virtual network peering -``` -# Remove the virtual network peering named myVnet1TomyVnet2 located in myVnet1 in the resource group named myResourceGroup. - -Remove-AzureRmVirtualNetworkPeering -Name "myVnet1TomyVnet2" -VirtualNetworkName "myVnet" -ResourceGroupName "myResourceGroup" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The virtual network peering name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -The virtual network name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index b7f56fc6ab..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 47FE9EF4-6000-4096-8F04-26A0C6661FDB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvirtualnetworksubnetconfig -schema: 2.0.0 ---- - -# Remove-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Removes a subnet configuration from a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVirtualNetworkSubnetConfig [-Name <String>] -VirtualNetwork <PSVirtualNetwork> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVirtualNetworkSubnetConfig** cmdlet removes a subnet from an Azure virtual network. - -## EXAMPLES - -### 1: Remove a subnet from a virtual network and update the virtual network -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet - -AddressPrefix "10.0.1.0/24" - -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix - "10.0.2.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet - $frontendSubnet,$backendSubnet - -Remove-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork - $virtualNetwork - $virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a resource group and a virtual network with two subnets. It then - uses the Remove-AzureRmVirtualNetworkSubnetConfig command to remove the backend subnet - from the in-memory representation of the virtual network. Set-AzureRmVirtualNetwork is - then called to modify the virtual network on the server side. - -## 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 -Specifies the name of the subnet configuration to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration to remove. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Set-AzureRmVirtualNetworkSubnetConfig](./Set-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRevokedCertificate.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRevokedCertificate.md deleted file mode 100644 index 5014114ee9..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRevokedCertificate.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 818C2250-DE43-409E-AC68-B4A7E945401E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnclientrevokedcertificate -schema: 2.0.0 ---- - -# Remove-AzureRmVpnClientRevokedCertificate - -## SYNOPSIS -Removes a VPN client-revocation certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVpnClientRevokedCertificate -VpnClientRevokedCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -Thumbprint <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVpnClientRevokedCertificate** cmdlet removes a client-revocation certificate from a virtual network gateway. -Client-revocation certificates prevent client computers from using the specified certificate for authentication. -If you remove a client-revocation certificate client computers can then use the previously-banned certificate to make a virtual private network (VPN) connection. - -## EXAMPLES - -### Example 1: Remove a client-revocation certificate from a virtual network gateway -``` -PS C:\>Remove-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName"ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command removes a client-revocation certificate from a virtual network gateway named ContosoVirtualNetwork. -In order to remove a client-revocation certificate, you must specify both the certificate name and the certificate thumbprint. - -## 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 the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier of the certificate being removed. - -You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: - -`Get-ChildItem -Path "Cert:\LocalMachine\Root"` - -The preceding command returns information for all the Local Computer certificates found in the Root certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway that the certificate is assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificateName -Specifies the name of the VPN client certificate being removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRevokedCertificate](./Add-AzureRmVpnClientRevokedCertificate.md) - -[Get-AzureRmVpnClientRevokedCertificate](./Get-AzureRmVpnClientRevokedCertificate.md) - -[New-AzureRmVpnClientRevokedCertificate](./New-AzureRmVpnClientRevokedCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRootCertificate.md b/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRootCertificate.md deleted file mode 100644 index afa829a1d5..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Remove-AzureRmVpnClientRootCertificate.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5D857FF6-A27D-4031-948D-8A69D24B4AD4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/remove-azurermvpnclientrootcertificate -schema: 2.0.0 ---- - -# Remove-AzureRmVpnClientRootCertificate - -## SYNOPSIS -Removes an existing VPN client root certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmVpnClientRootCertificate -VpnClientRootCertificateName <String> - -VirtualNetworkGatewayName <String> -ResourceGroupName <String> -PublicCertData <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmVpnClientRootCertificate** cmdlet removes the specified root certificate from a virtual network gateway. -Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate. -If you remove a root certificate computers that use the certificate for authentication purposes will no longer be able to connect to the gateway. - -When you use **Remove-AzureRmVpnClientRootCertificate**, you must supply both the certificate name and a text representation of the certificate data. -For more information about the text representation of a certificate see the *PublicCertData* parameter description. - -## EXAMPLES - -### Example 1: Remove a client root certificate from a virtual network gateway -``` -PS C:\>$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -PS C:\> $CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text[$i]} -PS C:\> Remove-AzureRmVpnClientRootCertificate -PublicCertData $CertificateText -ResourceGroupName "ContosoResourceGroup" -VirtualNetworkGatewayName "ContosoVirtualGateway"-VpnClientRootCertificateName "ContosoRootCertificate" -``` - -This example removes a client root certificate named ContosoRootCertificate from the virtual network gateway ContosoVirtualGateway. - -The first command uses the **Get-Content** cmdlet to get a previously-exported text representation of the certificate; this text representation is stored in a variable named $Text. - -The second command then uses a for loop to extract all the text in $Text except for the first line and the last line. -This extracted text is stored in a variable named $CertificateText. - -The third command uses the information stored in the $CertificateText variable along with the **Remove-AzureRmVpnClientRootCertificate** cmdlet to remove the certificate from the gateway. - -## 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 -``` - -### -PublicCertData -Specifies the text representation of the root certificate to be removed. -To obtain the text representation, export your certificate in .cer format (using Base64) encoding, then open the resulting file in a text editor. -You should see output similar to the following (note that the actual output will contain many more lines of text than the abbreviated sample shown here): - ------ BEGIN CERTIFICATE ----- -MIIC13FAAXC3671Auij9HHgUNEW8343NMJklo09982CVVFAw8w ------ END CERTIFICATE ----- - -The PublicCertData is made up of all the lines between the first line (----- BEGIN CERTIFICATE -----) and the last line (----- END CERTIFICATE -----) in the file. -You can retrieve the PublicCertData using Windows PowerShell commands similar to this: - -$Text = Get-Content -Path "C:\Azure\Certificates\ExportedCertficate.cer" -$CertificateText = for ($i=1; $i -lt $Text.Length -1 ; $i++){$Text\[$i\]} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway is assigned to. - -Resource groups categorize items to help simplify inventory management and general Azure administration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayName -Specifies the name of the virtual network gateway that the certificate is removed from. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificateName -Specifies the name of the client root certificate that this cmdlet removes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVpnClientRootCertificate](./Add-AzureRmVpnClientRootCertificate.md) - -[Get-AzureRmVpnClientRootCertificate](./Get-AzureRmVpnClientRootCertificate.md) - -[New-AzureRmVpnClientRootCertificate](./New-AzureRmVpnClientRootCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 9110649e60..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 443F6492-EFA7-4417-943A-3A8D47F8C83C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/reset-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# Reset-AzureRmVirtualNetworkGateway - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewayVip <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayVip -The gateway vip in order to reset particular gateway instance (e.g. in case of Active-Active feature enabled gateways.) By default, gateway primary instance will be reset if no value is passed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### String -Parameter 'GatewayVip' accepts value of type 'String' from the pipeline - -### PSVirtualNetworkGateway -Parameter 'VirtualNetworkGateway' accepts value of type 'PSVirtualNetworkGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGateway](./New-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGateway](./Set-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index 0aa19dc9f0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: AB370DAD-CED9-479D-BE08-B32EFF924A37 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/reset-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 ---- - -# Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> - -KeyLength <UInt32> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyLength -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - -[Set-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Resize-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Resize-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 5e0f2fbc09..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Resize-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DE2441FC-9504-4F3F-AEAF-37EDCD9B7275 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/resize-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# Resize-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Resizes an existing virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Resize-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> -GatewaySku <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Resize-AzureRmVirtualNetworkGateway** cmdlet enables you to change the stock-keeping unit (SKU) for a virtual network gateway. -SKUs determine the capabilities of a gateway, including such things as throughput and the maximum number of IP tunnels that are allowed. -Azure supports Basic, Standard, High-Performance, VpnGw1, VpnGw2 and VpnGw3 SKUs (sometimes referred to as Small, Medium, and Large SKUs). -For detailed information about the capabilities of each SKU type, see https://azure.microsoft.com/en-us/documentation/articles/vpn-gateway-about-vpngateways/. - -Keep in mind that SKUs differ in pricing as well as capabilities. -For more information, see https://azure.microsoft.com/en-us/pricing/details/vpn-gateway/. - -## EXAMPLES - -### Example 1: Change the size of a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Resize-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -GatewaySku "Basic" -``` - -This example changes the size of a virtual network gateway named ContosoVirtualGateway. - -The first command creates an object reference to ContosoVirtualGateway; this object reference is stored in a variable named $Gateway. - -The second command then uses the **Resize-AzureRmVirtualNetworkGateway** cmdlet to set the *GatewaySku* property to Basic. - -## 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 -``` - -### -GatewaySku -Specifies the new type of gateway SKU. -The acceptable values for this parameter are: - -- Basic -- Standard -- High Performance -- VpnGw1 -- VpnGw2 -- VpnGw3 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway to be resized. -You can create this object reference by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet accepts pipelined instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## OUTPUTS - -### -This cmdlet modifies existing instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## NOTES -You cannot resize from Basic/Standard/HighPerformance SKUs to the new VpnGw1/VpnGw2/VpnGw3 SKUs. See https://docs.microsoft.com/en-us/azure/vpn-gateway/vpn-gateway-about-vpngateways for instructions. - -## RELATED LINKS - -[Get-AzureRmVpnClientPackage](./Get-AzureRmVpnClientPackage.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Set-AzureRmVirtualNetworkGatewayVpnClientConfig](./Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGateway.md deleted file mode 100644 index 2fe65d0e54..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGateway.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7C8B47B4-2F6A-45EF-A351-88C8C3F9D0D3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgateway -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGateway - -## SYNOPSIS -Updates an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGateway** cmdlet updates an Azure application gateway. - -## EXAMPLES - -### Example 1: Update an application gateway -``` -PS C:\>$UpdatedAppGw = Set-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command updates the application gateway with settings in the $AppGw variable and stores the updated gateway in the $UpdatedAppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object representing the state to which the application gateway should be set. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Start-AzureRmApplicationGateway](./Start-AzureRmApplicationGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md deleted file mode 100644 index 53868ea26d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayAuthenticationCertificate.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0108A65B-E322-4783-AB6A-6AF1E1A58AC5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayauthenticationcertificate -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayAuthenticationCertificate - -## SYNOPSIS -Updates an authentication certificate for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayAuthenticationCertificate -ApplicationGateway <PSApplicationGateway> - -Name <String> -CertificateFile <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayAuthenticationCertificate** cmdlet updates an authentication certificate for an Azure application gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the name of application gateway for which this cmdlet updates an authentication certificate. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the authentication certificate file with which this cmdlet updates the certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 authentication certificate that this cmdlet updates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayAuthenticationCertificate](./Add-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Get-AzureRmApplicationGatewayAuthenticationCertificate](./Get-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[New-AzureRmApplicationGatewayAuthenticationCertificate](./New-AzureRmApplicationGatewayAuthenticationCertificate.md) - -[Remove-AzureRmApplicationGatewayAuthenticationCertificate](./Remove-AzureRmApplicationGatewayAuthenticationCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md deleted file mode 100644 index a875405268..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendAddressPool.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C2C5E0C0-E212-4554-966B-940B1B6FE235 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaybackendaddresspool -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayBackendAddressPool - -## SYNOPSIS -Updates a back-end address pool for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway <PSApplicationGateway> -Name <String> - [-BackendIPAddresses <System.Collections.Generic.List`1[System.String]>] - [-BackendFqdns <System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayBackendAddressPool** cmdlet updates a back-end address pool for an Azure application gateway. -Back-end addresses can be specified as IP addresses, fully-qualified domain names (FQDN) or IP configurations IDs. - -## EXAMPLES - -### Example 1: Setting a back-end address pool by using FQDNs -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendFqdns "contoso1.com", "contoso2.com" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The second command updates the back-end address pool of the application gateway in $AppGw by using FQDNs. - -### Example 2: Setting a back-end address pool by using backend server IP addresses -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendIPAddresses "10.10.10.10", "10.10.10.11" -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The second command updates the back-end address pool of the application gateway in $AppGw by using IP addresses. - -### Example 3: Setting a back-end address pool by using the ID of the backend server?s IP address -``` -PS C:\> $Nic01 = Get-AzureRmNetworkInterface -Name "Nic01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Nic02 = Get-AzureRmNetworkInterface -Name "Nic02" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendAddressPool -ApplicationGateway $AppGw -Name "Pool02" -BackendIPConfigurationIds $nic01.Properties.IpConfigurations[0].Id, $nic02.Properties.IpConfiguration[0].Id -``` - -The first command gets a network interface object named Nic01 that belongs to the resource group named ResourceGroup01, and stores it in the $Nic01 variable. - -The second command gets a network interface object named Nic02 that belongs to the resource group named ResourceGroup02, and stores it in the $Nic02 variable. - -The third command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The forth command uses the back-end IP configuration IDs from $Nic01 and $Nic02 to update the back-end address pool of the application gateway in $AppGw. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which this cmdlet associates the back-end address pool. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendFqdns -Specifies a list of back-end IP addresses to use as a back-end server pool. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendIPAddresses -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 back-end address pool. -This back-end address pool must exist in the application gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendAddressPool](./Add-AzureRmApplicationGatewayBackendAddressPool.md) - -[Get-AzureRmApplicationGatewayBackendAddressPool](./Get-AzureRmApplicationGatewayBackendAddressPool.md) - -[New-AzureRmApplicationGatewayBackendAddressPool](./New-AzureRmApplicationGatewayBackendAddressPool.md) - -[Remove-AzureRmApplicationGatewayBackendAddressPool](./Remove-AzureRmApplicationGatewayBackendAddressPool.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md deleted file mode 100644 index 6269b813bc..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayBackendHttpSettings.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaybackendhttpsettings -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayBackendHttpSettings - -## SYNOPSIS -Updates back-end HTTP settings for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> -Protocol <String> -CookieBasedAffinity <String> [-RequestTimeout <Int32>] - [-ConnectionDraining <PSApplicationGatewayConnectionDraining>] [-ProbeId <String>] - [-Probe <PSApplicationGatewayProbe>] - [-AuthenticationCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate]>] - [-PickHostNameFromBackendAddress] [-HostName <String>] [-AffinityCookieName <String>] [-ProbeEnabled] - [-Path <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmApplicationGatewayBackendHttpSettings cmdlet updates the back-end Hypertext Transfer Protocol (HTTP) settings for an Azure application gateway. -Back-end HTTP settings are applied to all back-end servers in a pool. - -## EXAMPLES - -### Example 1: Update the back-end HTTP settings for an application gateway -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayBackendHttpSettings -ApplicationGateway $AppGw -Name "Setting02" -Port 88 -Protocol "Http" -CookieBasedAffinity "Disabled" -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -The second command updates the HTTP settings of the application gateway in the $AppGw variable to use port 88, the HTTP protocol and enables cookie-based affinity. - -## PARAMETERS - -### -AffinityCookieName -Cookie name to use for the affinity cookie - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationGateway -Specifies an application gateway object with which this cmdlet associates back-end HTTP settings. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationCertificates -Specifies authentication certificates for the application gateway. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayAuthenticationCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionDraining -Connection draining of the backend http settings resource. - -```yaml -Type: PSApplicationGatewayConnectionDraining -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CookieBasedAffinity -Specifies whether cookie-based affinity should be enabled or disabled for the backend server pool. -The acceptable values for this parameter are: Disabled or Enabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Sets host header to be sent to the backend servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the back-end HTTP settings object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path which should be used as a prefix for all HTTP requests. -If no value is provided for this parameter, then no path will be prefixed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendAddress -Flag if host header should be picked from the host name of the backend server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port to use for each server in the back-end server pool. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with the back-end HTTP settings. - -```yaml -Type: PSApplicationGatewayProbe -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeEnabled -Flag if probe should be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with the back-end HTTP settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for communication between the application gateway and back-end servers. -The acceptable values for this parameter are: Http and Https. -This parameter is case-sensitive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTimeout -Specifies a request time-out value. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayBackendHttpSettings]() - -[Get-AzureRmApplicationGatewayBackendHttpSettings]() - -[New-AzureRmApplicationGatewayBackendHttpSettings]() - -[Remove-AzureRmApplicationGatewayBackendHttpSettings]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayConnectionDraining.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayConnectionDraining.md deleted file mode 100644 index f95f802aea..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayConnectionDraining.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayconnectiondraining -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayConnectionDraining - -## SYNOPSIS -Modifies the connection draining configuration of a back-end HTTP settings object. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings <PSApplicationGatewayBackendHttpSettings> - -Enabled <Boolean> -DrainTimeoutInSec <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet modifies the connection draining configuration of a back-end HTTP settings object. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Settings = Get-AzureRmApplicationGatewayBackendHttpSettings -Name "Settings01" -ApplicationGateway $AppGw -PS C:\> Set-AzureRmApplicationGatewayConnectionDraining -BackendHttpSettings $poolSetting02 -Enabled $False -DrainTimeoutInSec 3600 -``` - -The first command gets the application gateway named ApplicationGateway01 in the resource group named ResourceGroup01 and stores it in the $AppGw variable. -The second command gets the back-end HTTP settings named Settings01 for $AppGw and stores the settings in the $Settings variable. -The last command modifies the connection draining configuration of the back-end HTTP settings object stored in $Settings by setting Enabled to False and DrainTimeoutInSec to 3600. - -## PARAMETERS - -### -BackendHttpSettings -The backend http settings - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -DrainTimeoutInSec -The number of seconds connection draining is active. -Acceptable values are from 1 second to 3600 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether connection draining is enabled or not. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendHttpSettings - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayBackendHttpSettings](./Get-AzureRmApplicationGatewayBackendHttpSettings.md) - -[Get-AzureRmApplicationGatewayConnectionDraining](./Get-AzureRmApplicationGatewayConnectionDraining.md) - -[New-AzureRmApplicationGatewayConnectionDraining](./New-AzureRmApplicationGatewayConnectionDraining.md) - -[Remove-AzureRmApplicationGatewayConnectionDraining](./Remove-AzureRmApplicationGatewayConnectionDraining.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md deleted file mode 100644 index 8a742150cf..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendIPConfig.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C024C32-1B03-4BAA-AD31-4974D414C998 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayfrontendipconfig -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayFrontendIPConfig - -## SYNOPSIS -Modifies a front-end IP address configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-SubnetId <String>] [-PublicIPAddressId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - [-PrivateIPAddress <String>] [-Subnet <PSSubnet>] [-PublicIPAddress <PSPublicIpAddress>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayFrontendIPConfig** cmdlet updates a front-end IP configuration. - -An application gateway supports two types of front-end IP addresses: - -- Public IP addresses -- Private IP addresses for which the configuration uses Internal Load Balancing (ILB) - -An application gateway can have at most one public IP address and one private IP address. -A public IP address and a private IP address should be added separately as front-end IP addresses. - -## EXAMPLES - -### Example 1: Set a public IP as front-end IP of an application gateway -``` -PS C:\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp -``` - -The first command creates a public IP address object and stores it in the $PublicIp variable. - -The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The third command updates the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp. - -### Example 2: Set a static private IP as the front-end IP of an application gateway -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1 -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. - -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. - -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1. - -### Example 3: Set a dynamic private IP as the front-end IP of an application gateway -``` -PS C:\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -Subnet $Subnet -``` - -The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. - -The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. - -The third command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object in which to modify the front-end IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end IP configuration that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIPAddress -Specifies the private IP address. -If specified, this IP is statically allocated from the subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddress -Specifies the public IP address. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIPAddressId -Specifies the ID of the public IP address. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet that the application gateway uses. -Specify this parameter if the gateway uses a private IP address. -If the *PrivateIPAddress* address is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -Specify this parameter if the gateway uses a private IP address. -If the *PrivateIPAddress* parameter is specified, it should belong to this subnet. -If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Add-AzureRmApplicationGatewayFrontendIPConfig](./Add-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Get-AzureRmApplicationGatewayFrontendIPConfig](./Get-AzureRmApplicationGatewayFrontendIPConfig.md) - -[New-AzureRmApplicationGatewayFrontendIPConfig](./New-AzureRmApplicationGatewayFrontendIPConfig.md) - -[Remove-AzureRmApplicationGatewayFrontendIPConfig](./Remove-AzureRmApplicationGatewayFrontendIPConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendPort.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendPort.md deleted file mode 100644 index 2f8c13babd..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayFrontendPort.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 85C0A1C3-FC6D-496A-B6B5-8DC2A73B8032 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayfrontendport -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayFrontendPort - -## SYNOPSIS -Modifies a front-end port for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayFrontendPort -ApplicationGateway <PSApplicationGateway> -Name <String> - -Port <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayFrontendPort** cmdlet modifies a front-end port for an -application gateway. - -## EXAMPLES - -### Example 1: Set an application gateway front-end port to 80 -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayFrontendPort -ApplicationGateway $AppGw -Name "FrontEndPort01" -Port 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the -resource group named ResourceGroup01 and stores it in the $AppGw variable. - -The second command modifies the gateway in $AppGw to use port 80 for the front-end port named -FrontEndPort01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates the front-end port. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the front-end port to modify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number to use for the front-end port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayFrontendPort](./Add-AzureRmApplicationGatewayFrontendPort.md) - -[Get-AzureRmApplicationGatewayFrontendPort](./Get-AzureRmApplicationGatewayFrontendPort.md) - -[New-AzureRmApplicationGatewayFrontendPort](./New-AzureRmApplicationGatewayFrontendPort.md) - -[Remove-AzureRmApplicationGatewayFrontendPort](./Remove-AzureRmApplicationGatewayFrontendPort.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayHttpListener.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayHttpListener.md deleted file mode 100644 index e37223e349..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayHttpListener.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8068AF1-3380-4E60-B6CF-CC584BD053A7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayhttplistener -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayHttpListener - -## SYNOPSIS -Modifies an HTTP listener for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfigurationId <String>] [-FrontendPortId <String>] [-SslCertificateId <String>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway <PSApplicationGateway> -Name <String> - [-FrontendIPConfiguration <PSApplicationGatewayFrontendIPConfiguration>] - [-FrontendPort <PSApplicationGatewayFrontendPort>] [-SslCertificate <PSApplicationGatewaySslCertificate>] - [-HostName <String>] [-RequireServerNameIndication <String>] -Protocol <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayHttpListener** cmdlet modifies an HTTP listener for an Azure application gateway. - -## EXAMPLES - -### Example 1: Set an HTTP listener -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayHttpListener -ApplicationGateway $AppGw -Name "Listener01" -Protocol Http -FrontendIpConfiguration $FIP01 -FrontendPort 80 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -The second command sets the HTTP listener for the gateway to use the front-end configuration stored in $FIP01 with the HTTP protocol on port 80. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which this cmdlet associates the HTTP listener. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -FrontendIPConfiguration -Specifies the front-end IP address of the application gateway. - -```yaml -Type: PSApplicationGatewayFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIPConfigurationId -Specifies the ID of the front-end IP address of the application gateway. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the application gateway front-end port. - -```yaml -Type: PSApplicationGatewayFrontendPort -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortId -Specifies the application gateway front-end port ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the host name that this cmdlet sends the HTTP listener to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the HTTP listener. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that the HTTP listener uses. -The acceptable values for this parameter are: - -- Http -- Https - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireServerNameIndication -Specifies whether the cmdlet requires a server name indication. -The acceptable values for this parameter are: true or false. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: true, false - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificate -Specifies the SSL certificate of the HTTP listener. - -```yaml -Type: PSApplicationGatewaySslCertificate -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslCertificateId -Specifies the Secure Socket Layer (SSL) certificate ID of the HTTP listener. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayHttpListener](./Add-AzureRmApplicationGatewayHttpListener.md) - -[Get-AzureRmApplicationGatewayHttpListener](./Get-AzureRmApplicationGatewayHttpListener.md) - -[New-AzureRmApplicationGatewayHttpListener](./New-AzureRmApplicationGatewayHttpListener.md) - -[Remove-AzureRmApplicationGatewayHttpListener](./Remove-AzureRmApplicationGatewayHttpListener.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayIPConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayIPConfiguration.md deleted file mode 100644 index 9720a9be22..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayIPConfiguration.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 4D5F469D-FF1F-4D49-AC42-26E6DECFAA26 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayipconfiguration -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayIPConfiguration - -## SYNOPSIS -Modifies an IP configuration for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-SubnetId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - [-Subnet <PSSubnet>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayIPConfiguration** cmdlet modifies an IP configuration. -An IP configuration contains the subnet in which an application gateway is deployed. - -## EXAMPLES - -### Example 1: Set the goal state of an IP configuration -``` -PS C:\>$VNet = Get-AzureRmVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -PS C:\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayIPConfiguration -ApplicationGateway $AppGw -Name "AppgwSubnet01" -Subnet $Subnets -``` - -The first command gets the virtual network named VNet01 that belongs to the resource group named ResourceGroup01 and stores it in the $VNet variable. - -The second command gets the subnet configuration named Subnet01 using $VNet and stores it in the $Subnet variable. - -The third command gets an application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01 and stores it in the $AppGw variable. - -The forth command sets the IP configuration of the application gateway stored in $AppGw to the subnet configuration stored in $Subnet. - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object with which this cmdlet associates an IP configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -Name -Specifies the name of the IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the subnet. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the subnet ID. -This is the subnet in which the application gateway is deployed. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Add-AzureRmApplicationGatewayIPConfiguration](./Add-AzureRmApplicationGatewayIPConfiguration.md) - -[Get-AzureRmApplicationGatewayIPConfiguration](./Get-AzureRmApplicationGatewayIPConfiguration.md) - -[New-AzureRmApplicationGatewayIPConfiguration](./New-AzureRmApplicationGatewayIPConfiguration.md) - -[Remove-AzureRmApplicationGatewayIPConfiguration](./Remove-AzureRmApplicationGatewayIPConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayProbeConfig.md deleted file mode 100644 index 531c44ddff..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayProbeConfig.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayprobeconfig -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayProbeConfig - -## SYNOPSIS -Sets the health probe configuration on an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -Protocol <String> [-HostName <String>] -Path <String> -Interval <Int32> -Timeout <Int32> - -UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] - [-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmApplicationGatewayProbeConfig cmdlet sets the health probe configuration on an existing Application Gateway. - -## EXAMPLES - -### Example 1: Set the configuration for a health probe on an application gateway -``` -PS C:\>Set-AzureRmApplicationGatewayProbeConfig -ApplicationGateway Gateway -Name "Probe05" -Protocol Http -HostName "contoso.com" -Path "/path/custompath.htm" -Interval 30 -Timeout 120 -UnhealthyThreshold 8 -``` - -This command sets the configuration for a health probe named Probe05 for the application gateway named Gateway. -The command also sets the unhealthy threshold to 8 retries and times out after 120 seconds. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet sends a probe. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -HostName -Specifies the host name that this cmdlet sends the probe to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Interval -Specifies the probe interval in seconds. -This is the time interval between two consecutive probes. -This value is between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Match -Body that must be contained in the health response. -Default value is empty - -```yaml -Type: PSApplicationGatewayProbeHealthResponseMatch -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinServers -Minimum number of servers that are always marked healthy. -Default value is 0 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the relative path of probe. -Valid paths start with the slash character (/). -The probe is sent to \<Protocol\>://\<host\>:\<port\>\<path\>. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PickHostNameFromBackendHttpSettings -Whether the host header should be picked from the backend http settings. -Default value is false - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol used to send probe. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Http, Https - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the probe timeout in seconds. -This cmdlet marks the probe as failed if a valid response is not received with this timeout period. -Valid values are between 1 second and 86400 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnhealthyThreshold -Specifies the probe retry count. -The backend server is marked down after consecutive probe failure count reaches the unhealthy threshold. -Valid values are between 1 second and 20 seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayProbeConfig]() - -[Get-AzureRmApplicationGatewayProbeConfig]() - -[New-AzureRmApplicationGatewayProbeConfig]() - -[Remove-AzureRmApplicationGatewayProbeConfig]() - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md deleted file mode 100644 index 70fde6bf09..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRedirectConfiguration.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayredirectconfiguration -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayRedirectConfiguration - -## SYNOPSIS -Sets the redirect configuration on an existing Application Gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListenerID <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetListener <PSApplicationGatewayHttpListener>] [-IncludePath <Boolean>] - [-IncludeQueryString <Boolean>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByURL -``` -Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -Name <String> - -RedirectType <String> [-TargetUrl <String>] [-IncludePath <Boolean>] [-IncludeQueryString <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -**The Set-AzureRmApplicationGatewayRequestRoutingRule** cmdlet modifies a redirect configuration. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayRedirectConfiguration -ApplicationGateway $appgw -Name "RedirectConfig01" -RedirectType Permanent -TargetUrl "https://www.contoso.com" -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. - -The second command modifies the redirect configuration for the application gateway to redirect type Permanent and use a target url. - -## PARAMETERS - -### -ApplicationGateway -The applicationGateway - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -IncludePath -Include path in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeQueryString -Include query string in the redirected url. -Default is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Redirect Configuration - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectType -The type of redirect - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Permanent, Found, SeeOther, Temporary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListener -HTTPListener to redirect the request to - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListenerID -ID of listener to redirect the request to - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl -Target URL fo redirection - -```yaml -Type: String -Parameter Sets: SetByURL -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md deleted file mode 100644 index 00493cb53f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayRequestRoutingRule.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 75A4826A-7A5F-4742-9DC4-DC728CED63D0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayrequestroutingrule -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayRequestRoutingRule - -## SYNOPSIS -Modifies a request routing rule for an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettingsId <String>] [-HttpListenerId <String>] - [-BackendAddressPoolId <String>] [-UrlPathMapId <String>] [-RedirectConfigurationId <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway <PSApplicationGateway> -Name <String> - -RuleType <String> [-BackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-HttpListener <PSApplicationGatewayHttpListener>] - [-BackendAddressPool <PSApplicationGatewayBackendAddressPool>] [-UrlPathMap <PSApplicationGatewayUrlPathMap>] - [-RedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayRequestRoutingRule** cmdlet modifies a request routing rule. - -## EXAMPLES - -### Example 1: Update a request routing rule -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewayRequestRoutingRule -ApplicationGateway $AppGw -Name "Rule01" -RuleType Basic -BackendHttpSettings $Setting -HttpListener $Listener -BackendAddressPool $Pool -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. - -The second command modifies the request routing rule for the application gateway to use back-end HTTP settings specified in the $Setting variable, an HTTP listener specified in the $Listener variable, and a back-end address pool specified in the $Pool variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates a request routing rule. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BackendAddressPool -Specifies the application gateway back-end address pool. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the application gateway back-end address pool ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettings -Specifies the application gateway backend HTTP settings. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendHttpSettingsId -Specifies the application gateway back-end HTTP settings ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListener -Specifies the application gateway HTTP listener. - -```yaml -Type: PSApplicationGatewayHttpListener -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpListenerId -Specifies the application gateway HTTP listener ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the request routing rule that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfiguration -Application gateway RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectConfigurationId -ID of the application gateway RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies the type of request routing rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, PathBasedRouting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMap -```yaml -Type: PSApplicationGatewayUrlPathMap -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UrlPathMapId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayRequestRoutingRule](./Add-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Get-AzureRmApplicationGatewayRequestRoutingRule](./Get-AzureRmApplicationGatewayRequestRoutingRule.md) - -[New-AzureRmApplicationGatewayRequestRoutingRule](./New-AzureRmApplicationGatewayRequestRoutingRule.md) - -[Remove-AzureRmApplicationGatewayRequestRoutingRule](./Remove-AzureRmApplicationGatewayRequestRoutingRule.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySku.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySku.md deleted file mode 100644 index 33bb320c3c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySku.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 3D88F561-7FE4-4017-BAC4-8F085AD037A9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysku -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewaySku - -## SYNOPSIS -Modifies the SKU of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySku -ApplicationGateway <PSApplicationGateway> -Name <String> -Tier <String> - -Capacity <Int32> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySku** cmdlet modifies the stock keeping unit (SKU) of an application gateway. - -## EXAMPLES - -### Example 1: Update the application gateway SKU -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewaySku -ApplicationGateway $AppGw -Name "Standard_Small" -Tier "Standard" -Capacity 2 -``` - -The first command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. - -The second command updates the SKU of the application gateway. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway object with which this cmdlet associates the SKU. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Capacity -Specifies the instance count of the application gateway. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 application gateway. -The acceptable values for this parameter are: - -- Standard_Small -- Standard_Medium -- Standard_Large -- WAF_Medium -- WAF_Large - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Specifies the tier of the application gateway. -The acceptable values for this parameter are: - -- Standard -- WAF - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Standard, WAF - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySku](./Get-AzureRmApplicationGatewaySku.md) - -[New-AzureRmApplicationGatewaySku](./New-AzureRmApplicationGatewaySku.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslCertificate.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslCertificate.md deleted file mode 100644 index e3bf63d86c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslCertificate.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D7C275E5-BC43-454B-BF1E-48D639C4B4F0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysslcertificate -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewaySslCertificate - -## SYNOPSIS -Sets the goal state of an SSL certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String> - -CertificateFile <String> -Password <SecureString> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySslCertificate** cmdlet sets the goal state of an SSL certificate. - -## EXAMPLES - -### Example 1: Set the goal state of an SSL certificate -``` -PS C:\> $appGW = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force -PS C:\> $cert = Set-AzureRmApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password -``` - -This command sets the goal state for an SSL certificate from the application gateway named ApplicationGateway01. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway with which the Secure Socket Layer (SSL) certificate is associated. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertificateFile -Specifies the path of the SSL certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 SSL certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -Specifies the password of the SSL certificate. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewaySslCertificate](./Add-AzureRmApplicationGatewaySslCertificate.md) - -[Get-AzureRmApplicationGatewaySslCertificate](./Get-AzureRmApplicationGatewaySslCertificate.md) - -[New-AzureRmApplicationGatewaySslCertificate](./New-AzureRmApplicationGatewaySslCertificate.md) - -[Remove-AzureRmApplicationGatewaySslCertificate](./Remove-AzureRmApplicationGatewaySslCertificate.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslPolicy.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslPolicy.md deleted file mode 100644 index 4ccd527400..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewaySslPolicy.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 30A34CA8-AC07-4327-B7B9-19F001DA996A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaysslpolicy -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewaySslPolicy - -## SYNOPSIS -Modifies the SSL policy of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewaySslPolicy -ApplicationGateway <PSApplicationGateway> - [-DisabledSslProtocols <System.Collections.Generic.List`1[System.String]>] [-PolicyType <String>] - [-PolicyName <String>] [-CipherSuite <System.Collections.Generic.List`1[System.String]>] - [-MinProtocolVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewaySslPolicy** cmdlet modifies the SSL policy of an application gateway. - -## EXAMPLES - -### 1: -``` -PS C:\>$AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> $AppGw = Set-AzureRmApplicationGatewaySslPolicy -ApplicationGateway $getgw -PolicyType Predefined -PolicyName AppGwSslPolicy20170401 -``` - -The first command gets the application gateway named ApplicationGateway01 and stores it in the $AppGw variable. - -This second command modifies the ssl policy to a policy type Predefined and policy name AppGwSslPolicy20170401. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway of the SSL policy that this cmdlet modifies. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CipherSuite -Ssl cipher suites to be enabled in the specified order to application gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledSslProtocols -Specifies which protocols are disabled. -The acceptable values for this parameter are: - -- TLSv1_0 -- TLSv1_1 -- TLSv1_2 - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinProtocolVersion -Minimum version of Ssl protocol to be supported on application gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: TLSv1_0, TLSv1_1, TLSv1_2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of Ssl predefined policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType -Type of Ssl Policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Predefined, Custom - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmApplicationGatewaySslPolicy](./Get-AzureRmApplicationGatewaySslPolicy.md) - -[New-AzureRmApplicationGatewaySslPolicy](./New-AzureRmApplicationGatewaySslPolicy.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md deleted file mode 100644 index d2b1171505..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayUrlPathMapConfig.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9F5EC8E7-12E9-40E5-B98D-AAFD8F9F3C37 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewayurlpathmapconfig -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayUrlPathMapConfig - -## SYNOPSIS -Sets configuration for an array of URL path mappings to a backend server pool. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>] - [-DefaultRedirectConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String> - -PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]> - [-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>] - [-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>] - [-DefaultRedirectConfiguration <PSApplicationGatewayRedirectConfiguration>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet sets configuration for an array of URL path mappings to a backend server pool. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway to which this cmdlet sets a URL path map configuration. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPool -Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendAddressPoolId -Specifies the default backend address pool ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettings -Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match. - -```yaml -Type: PSApplicationGatewayBackendHttpSettings -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultBackendHttpSettingsId -Specifies the default backend HTTP settings ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfiguration -Application gateway default RedirectConfiguration - -```yaml -Type: PSApplicationGatewayRedirectConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultRedirectConfigurationId -ID of the application gateway default RedirectConfiguration - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the URL path map name in which this cmdlet sets configuration for. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathRules -Specifies a list of path rules. -Note that the path rules are order sensitive, they are applied in order they are specified. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Add-AzureRmApplicationGatewayUrlPathMapConfig](./Add-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md) - -[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md deleted file mode 100644 index 227a8251a4..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 46FDE4D8-08E0-4465-8BF9-849A108628B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermapplicationgatewaywebapplicationfirewallconfiguration -schema: 2.0.0 ---- - -# Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration - -## SYNOPSIS -Modifies the WAF configuration of an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway <PSApplicationGateway> - -Enabled <Boolean> -FirewallMode <String> [-RuleSetType <String>] [-RuleSetVersion <String>] - [-DisabledRuleGroups <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration** cmdlet modifies the web application firewall (WAF) configuration of an application gateway. - -## EXAMPLES - -### Example 1: Update the application gateway web application firewall configuration -``` -PS C:\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01" -PS C:\> Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration -ApplicationGateway $AppGw -Enabled $True -FirewallMode "Detection" -RuleSetType "OWASP" -RuleSetVersion "3.0" -``` - -The first command gets the application gateway named ApplicationGateway01 and then stores it in the $AppGw variable. - -The second command enables the firewall configuration for the application gateway stored in $AppGw and sets the firewall mode to "Detection", RuleSetType to "OWASP" and the RuleSetVersion to "3.0". - -## PARAMETERS - -### -ApplicationGateway -Specifies an application gateway object. -You can use the Get-AzureRmApplicationGateway cmdlet to get an application gateway object. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 -``` - -### -DisabledRuleGroups -The disabled rule groups. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayFirewallDisabledRuleGroup] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether the web application firewall is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirewallMode -Specifies the web application firewall mode. -The acceptable values for this parameter are: - -- Detection -- Prevention - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Detection, Prevention - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetType -The type of the web application firewall rule set. -The acceptable values for this parameter are: - -- OWASP - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: OWASP - -Required: False -Position: Named -Default value: OWASP -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleSetVersion -The version of the rule set type. -The acceptable values for this parameter are: - -- 3.0 -- 2.2.9 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: 3.0, 2.2.9 - -Required: False -Position: Named -Default value: 3.0 -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSApplicationGateway -Parameter 'ApplicationGateway' accepts value of type 'PSApplicationGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - -[New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration](./New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuit.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuit.md deleted file mode 100644 index d0870eaaf5..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuit.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2A3B7343-9AA0-4505-AEDE-31C0C5B98694 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermexpressroutecircuit -schema: 2.0.0 ---- - -# Set-AzureRmExpressRouteCircuit - -## SYNOPSIS -Modifies an ExpressRoute circuit. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit <PSExpressRouteCircuit> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmExpressRouteCircuit** cmdlet saves the modified ExpressRoute circuit to Azure. - -## EXAMPLES - -### Example 1: Change the ServiceKey of an ExpressRoute circuit -``` -$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$ckt.ServiceKey = '64ce99dd-ee70-4e74-b6b8-91c6307433a0' -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $ckt -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpressRouteCircuit -Specifies the **ExpressRouteCircuit** object that this cmdlet modifies. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md) - -[Move-AzureRmExpressRouteCircuit](./Move-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuit](./New-AzureRmExpressRouteCircuit.md) - -[Remove-AzureRmExpressRouteCircuit](./Remove-AzureRmExpressRouteCircuit.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md deleted file mode 100644 index 221fead6ea..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmExpressRouteCircuitPeeringConfig.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6C0281EC-4D23-4BD0-A268-4C278ABC7B1A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermexpressroutecircuitpeeringconfig -schema: 2.0.0 ---- - -# Set-AzureRmExpressRouteCircuitPeeringConfig - -## SYNOPSIS -Saves a modified ExpressRoute peering configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilterId -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] -RouteFilterId <String> - [-PeerAddressType <String>] [-LegacyMode <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### MicrosoftPeeringConfigRoutFilter -``` -Set-AzureRmExpressRouteCircuitPeeringConfig -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit> - -PeeringType <String> -PeerASN <Int32> -PrimaryPeerAddressPrefix <String> -SecondaryPeerAddressPrefix <String> - -VlanId <Int32> [-SharedKey <String>] - [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] - [-MicrosoftConfigCustomerAsn <Int32>] [-MicrosoftConfigRoutingRegistryName <String>] - -RouteFilter <PSRouteFilter> [-PeerAddressType <String>] [-LegacyMode <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmExpressRouteCircuitPeeringConfig** cmdlets saves a modified ExpressRoute peering -configuration back to Azure. - -## EXAMPLES - -### Example 1: Change an existing peering configuration -``` -$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg -$parameters = @{ - Name = 'AzurePrivatePeering' - Circuit = $circuit - PeeringType = 'AzurePrivatePeering' - PeerASN = 100 - PrimaryPeerAddressPrefix = '10.6.1.0/30' - SecondaryPeerAddressPrefix = '10.6.2.0/30' - VlanId = 201 -} -Set-AzureRmExpressRouteCircuitPeeringConfig @parameters -Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit -``` - -## 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 -``` - -### -ExpressRouteCircuit -The ExpressRoute circuit object containing the peering configuration to be modified. - -```yaml -Type: PSExpressRouteCircuit -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LegacyMode -The legacy mode of the Peering - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MicrosoftConfigAdvertisedPublicPrefixes -For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to -advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma -separated list if you plan to send a set of prefixes. These prefixes must be registered to you in -a Routing Registry Name (RIR / IRR). - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigCustomerAsn -If you are advertising prefixes that are not registered to the peering AS number, you can specify -the AS number to which they are registered. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MicrosoftConfigRoutingRegistryName -The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the peering configuration to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeerAddressType -PeerAddressType - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerASN -The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is -AzurePublicPeering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PeeringType -The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and -`MicrosoftPeering` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryPeerAddressPrefix -This is the IP Address range for the primary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -This is an existing RouteFilter object. - -```yaml -Type: PSRouteFilter -Parameter Sets: MicrosoftPeeringConfigRoutFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteFilterId -This is the resource Id of an existing RouteFilter object. - -```yaml -Type: String -Parameter Sets: MicrosoftPeeringConfigRoutFilterId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryPeerAddressPrefix -This is the IP Address range for the secondary routing path of this peering relationship. This must -be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your -router interface. Azure will configure the next even-numbered address to the Azure router interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedKey -This is an optional MD5 hash used as a pre-shared key for the peering configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -This is the Id number of the VLAN assigned for this peering. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSExpressRouteCircuit -Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit - -## NOTES - -## RELATED LINKS - -[Add-AzureRmExpressRouteCircuitPeeringConfig](Add-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Get-AzureRmExpressRouteCircuit](Get-AzureRmExpressRouteCircuit.md) - -[New-AzureRmExpressRouteCircuitPeeringConfig](New-AzureRmExpressRouteCircuitPeeringConfig.md) - -[Remove-AzureRmExpressRouteCircuitPeeringConfig](Remove-AzureRmExpressRouteCircuitPeeringConfig.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancer.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancer.md deleted file mode 100644 index 4b22f59796..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancer.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 494E185D-3746-4959-846E-660017A1F392 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancer -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancer - -## SYNOPSIS -Sets the goal state for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLoadBalancer -LoadBalancer <PSLoadBalancer> [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancer** cmdlet sets the goal state for an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "NRPLB" -ResourceGroupName "NRP-RG" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewRule" -FrontendIpConfiguration $slb.FrontendIpConfigurations[0] -FrontendPort 81 -BackendPort 8181 -Protocol "TCP" -PS C:\> $slb | Set-AzureRmLoadBalancer -``` - -The first command gets the load balancer named NRPLB, and then stores it in the $slb variable. - -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule named NewRule. - -The third command passes the load balancer to **Set-AzureRmLoadBalancer**, which updates the load balancer configuration and saves it. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[New-AzureRmLoadBalancer](./New-AzureRmLoadBalancer.md) - -[Remove-AzureRmLoadBalancer](./Remove-AzureRmLoadBalancer.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md deleted file mode 100644 index 9ff541f9db..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerFrontendIpConfig.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C23BEF37-D472-43EC-90AA-F8742247ABA2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerfrontendipconfig -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancerFrontendIpConfig - -## SYNOPSIS -Sets the goal state for a front-end IP configuration in a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceSubnet -``` -Set-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-PrivateIpAddress <String>] -Subnet <PSSubnet> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceIdSubnet -``` -Set-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-PrivateIpAddress <String>] -SubnetId <String> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceIdPublicIpAddress -``` -Set-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - -PublicIpAddressId <String> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourcePublicIpAddress -``` -Set-AzureRmLoadBalancerFrontendIpConfig -Name <String> -LoadBalancer <PSLoadBalancer> - -PublicIpAddress <PSPublicIpAddress> [-Zone <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerFrontendIpConfig** cmdlet sets the goal state for a front-end IP configuration in an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify the front-end IP configuration of a load balancer -``` -PS C:\>$Subnet = Get-AzureRmVirtualNetwork -Name "MyVnet" -ResourceGroupName "MyResourceGroup" | Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet" -PS C:\> $slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet -PS C:\> $slb | Set-AzureRmLoadBalancerFrontendIpConfig -Name "NewFrontend" -Subnet $Subnet -``` - -The first command gets the virtual subnet named Subnet, and then stores it in the $Subnet variable. - -The second command gets the associated load balancer named MyLoadBalancer, and then stores it in the $slb variable. - -The third command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerFrontendIpConfig, which creates a front-end IP configuration named NewFrontend for $slb. - -The fourth command passes the load balancer in $slb to **Set-AzureRmLoadBalancerFrontendIpConfig**, which saves and updates the front-end IP configuration. - -## 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 -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for a front-end configuration for the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the front-end IP configuration to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the private IP address of the load balancer that is associated with the front-end IP configuration to set. -Specify this parameter only if you also specify the *Subnet* parameter. - -```yaml -Type: String -Parameter Sets: SetByResourceSubnet, SetByResourceIdSubnet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies the **PublicIpAddress** object that is associated with the front-end IP configuration to set. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResourcePublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -Specifies the ID of the **PublicIpAddress** object that is associated with the front-end IP configuration that this cmdlet sets. - -```yaml -Type: String -Parameter Sets: SetByResourceIdPublicIpAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies the **Subnet** object that contains the front-end IP configuration that this cmdlet sets. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResourceSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -Specifies the ID of the subnet that contains the front-end IP configuration that this cmdlet sets. - -```yaml -Type: String -Parameter Sets: SetByResourceIdSubnet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Zone -A list of availability zones denoting the IP allocated for the resource needs to come from. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerFrontendIpConfig](./Add-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerFrontendIpConfig](./Get-AzureRmLoadBalancerFrontendIpConfig.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmLoadBalancerFrontendIpConfig](./New-AzureRmLoadBalancerFrontendIpConfig.md) - -[Remove-AzureRmLoadBalancerFrontendIpConfig](./Remove-AzureRmLoadBalancerFrontendIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md deleted file mode 100644 index cee5da97fb..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatPoolConfig.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 355DF798-6233-45C6-9416-8AB0E0D7DC02 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerinboundnatpoolconfig -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancerInboundNatPoolConfig - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmLoadBalancerInboundNatPoolConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] -Protocol <String> -FrontendPortRangeStart <Int32> - -FrontendPortRangeEnd <Int32> -BackendPort <Int32> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -BackendPort -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeEnd -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPortRangeStart -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatPoolConfig](./Add-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[Get-AzureRmLoadBalancerInboundNatPoolConfig](./Get-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[New-AzureRmLoadBalancerInboundNatPoolConfig](./New-AzureRmLoadBalancerInboundNatPoolConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatPoolConfig](./Remove-AzureRmLoadBalancerInboundNatPoolConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md deleted file mode 100644 index 33894abcfc..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerInboundNatRuleConfig.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 87818605-EFA6-422E-9ECD-0A0BF269DCFD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerinboundnatruleconfig -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancerInboundNatRuleConfig - -## SYNOPSIS -Sets an inbound NAT rule configuration for a load balancer. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] - [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmLoadBalancerInboundNatRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-Protocol <String>] [-FrontendPort <Int32>] - [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] [-EnableFloatingIP] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerInboundNatRuleConfig** cmdlet sets an inbound network address translation (NAT) rule configuration for an Azure load balancer. - -## EXAMPLES - -### Example 1: Modify the inbound NAT rule configuration on a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -PS C:\> $slb | Set-AzureRmLoadBalancerInboundNatRuleConfig -Name "NewNatRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. - -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerInboundNatRuleConfig, which adds an inbound NAT rule configuration to it. - -The third command passes the load balancer to **Set-AzureRmLoadBalancerInboundNatRuleConfig**, which saves and updates the inbound NAT rule configuration. -Note that the rule configuration was set without enabling floating IP, which had been enabled by the previous command. - -## PARAMETERS - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with an inbound NAT rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, that the state of conversations is maintained in a load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets an inbound NAT rule configuration for the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an inbound NAT rule configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by an inbound NAT rule configuration. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerInboundNatRuleConfig](./Add-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerInboundNatRuleConfig](./Get-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[New-AzureRmLoadBalancerInboundNatRuleConfig](./New-AzureRmLoadBalancerInboundNatRuleConfig.md) - -[Remove-AzureRmLoadBalancerInboundNatRuleConfig](./Remove-AzureRmLoadBalancerInboundNatRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerProbeConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerProbeConfig.md deleted file mode 100644 index 4116a6fbb4..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerProbeConfig.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: C8B91455-C1A7-43BD-9E63-A20E2694371F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerprobeconfig -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancerProbeConfig - -## SYNOPSIS -Sets the goal state for a probe configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLoadBalancerProbeConfig -Name <String> -LoadBalancer <PSLoadBalancer> [-RequestPath <String>] - [-Protocol <String>] -Port <Int32> -IntervalInSeconds <Int32> -ProbeCount <Int32> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerProbeConfig** cmdlet sets the goal state for a probe configuration. - -## EXAMPLES - -### Example 1: Modify the probe configuration on a load balancer -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Protocol "http" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -RequestPath "healthcheck.aspx" -PS C:\> $slb | Set-AzureRmLoadBalancerProbeConfig -Name "NewProbe" -Port 80 -IntervalInSeconds 15 -ProbeCount 2 -``` - -The first command gets the loadbalancer named MyLoadBalancer, and then stores it in the $slb variable. - -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerProbeConfig, which adds a new probe configuration to it. - -The third command passes the load balancer to **Set-AzureRmLoadBalancerProbeConfig**, which sets the new configuration. -Note that it is necessary to specify several of the same parameters that were specified in the previous command because they are required by the current cmdlet. - -## 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 -``` - -### -IntervalInSeconds -Specifies the interval, in seconds, between probes to each instance of the load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state for a probe configuration for the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the probe configuration that this cmdlet sets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port on which probes should connect to a load-balanced service. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeCount -Specifies the number of per-instance consecutive failures for an instance to be considered unhealthy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol to use for the probing. -The acceptable values for this parameter are: Tcp or Http. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Http - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestPath -Specifies the path in the load-balanced service to probe to determine health. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerProbeConfig](./Add-AzureRmLoadBalancerProbeConfig.md) - -[Get-AzureRmLoadBalancer](./Get-AzureRmLoadBalancer.md) - -[Get-AzureRmLoadBalancerProbeConfig](./Get-AzureRmLoadBalancerProbeConfig.md) - -[New-AzureRmLoadBalancerProbeConfig](./New-AzureRmLoadBalancerProbeConfig.md) - -[Remove-AzureRmLoadBalancerProbeConfig](./Remove-AzureRmLoadBalancerProbeConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerRuleConfig.md deleted file mode 100644 index d86f72cf33..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLoadBalancerRuleConfig.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2638B226-B974-43B6-ACC2-D67573CF6B56 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermloadbalancerruleconfig -schema: 2.0.0 ---- - -# Set-AzureRmLoadBalancerRuleConfig - -## SYNOPSIS -Sets the goal state for a load balancer rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceId -``` -Set-AzureRmLoadBalancerRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfigurationId <String>] [-BackendAddressPoolId <String>] [-ProbeId <String>] - [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] [-IdleTimeoutInMinutes <Int32>] - [-LoadDistribution <String>] [-EnableFloatingIP] [-DisableOutboundSNAT] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResource -``` -Set-AzureRmLoadBalancerRuleConfig -Name <String> -LoadBalancer <PSLoadBalancer> - [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-BackendAddressPool <PSBackendAddressPool>] - [-Probe <PSProbe>] [-Protocol <String>] [-FrontendPort <Int32>] [-BackendPort <Int32>] - [-IdleTimeoutInMinutes <Int32>] [-LoadDistribution <String>] [-EnableFloatingIP] [-DisableOutboundSNAT] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLoadBalancerRuleConfig** cmdlet sets the goal state for a load balancer rule configuration. - -## EXAMPLES - -### Example 1: Modify a load balancing rule configuration -``` -PS C:\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup" -PS C:\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP -PS C:\> $slb | Set-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp" -FrontendPort 3350 -BackendPort 3350 -``` - -The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable. - -The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerRuleConfig, which adds a rule named NewRule to it. - -The third command passes the load balancer to **Set-AzureRmLoadBalancerRuleConfig**, which sets the new rule configuration. -Note that the configuration does not enable a floating IP address, which had been enabled by the previous command. - -## PARAMETERS - -### -BackendAddressPool -Specifies a **BackendAddressPool** object to associate with a load balancer rule. - -```yaml -Type: PSBackendAddressPool -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendAddressPoolId -Specifies the ID of a **BackendAddressPool** object to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackendPort -Specifies the backend port for traffic that is matched by this rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableOutboundSNAT -Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFloatingIP -Indicates that this cmdlet enables a floating IP address for a rule configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfiguration -Specifies a list of front-end IP addresses to associate with a load balancer rule configuration. - -```yaml -Type: PSFrontendIPConfiguration -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendIpConfigurationId -Specifies the ID for a front-end IP address configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FrontendPort -Specifies the front-end port that is matched by a load balancer rule configuration. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdleTimeoutInMinutes -Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancer -Specifies a load balancer. -This cmdlet sets the goal state rule configuration for the load balancer that this parameter specifies. - -```yaml -Type: PSLoadBalancer -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LoadDistribution -Specifies a load distribution. -The acceptable values for this parameter are: SourceIP and SourceIPProtocol. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Default, SourceIP, SourceIPProtocol - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a load balancer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Probe -Specifies a probe to associate with a load balancer rule configuration. - -```yaml -Type: PSProbe -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeId -Specifies the ID of the probe to associate with a load balancer rule configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the protocol that is matched by a load balancer rule. -The acceptable values for this parameter are: Tcp or Udp. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, All - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLoadBalancer -Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLoadBalancer - -## NOTES - -## RELATED LINKS - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Add-AzureRmLoadBalancerRuleConfig](./Add-AzureRmLoadBalancerRuleConfig.md) - -[Get-AzureRmLoadBalancerRuleConfig](./Get-AzureRmLoadBalancerRuleConfig.md) - -[New-AzureRmLoadBalancerRuleConfig](./New-AzureRmLoadBalancerRuleConfig.md) - -[Remove-AzureRmLoadBalancerRuleConfig](./Remove-AzureRmLoadBalancerRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLocalNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLocalNetworkGateway.md deleted file mode 100644 index 9c1f9995e6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmLocalNetworkGateway.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: F8C1DF39-1DAF-4BDB-8B0E-1BC3B5E82185 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermlocalnetworkgateway -schema: 2.0.0 ---- - -# Set-AzureRmLocalNetworkGateway - -## SYNOPSIS -Modifies a local network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmLocalNetworkGateway -LocalNetworkGateway <PSLocalNetworkGateway> - [-AddressPrefix <System.Collections.Generic.List`1[System.String]>] [-Asn <UInt32>] - [-BgpPeeringAddress <String>] [-PeerWeight <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmLocalNetworkGateway** cmdlet modifies a local network gateway. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AddressPrefix -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BgpPeeringAddress -```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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalNetworkGateway -```yaml -Type: PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PeerWeight -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSLocalNetworkGateway -Parameter 'LocalNetworkGateway' accepts value of type 'PSLocalNetworkGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSLocalNetworkGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[New-AzureRmLocalNetworkGateway](./New-AzureRmLocalNetworkGateway.md) - -[Remove-AzureRmLocalNetworkGateway](./Remove-AzureRmLocalNetworkGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterface.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterface.md deleted file mode 100644 index c12a7856b6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterface.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: DDB38A77-E5C0-47DD-BADD-94488F661CD5 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkinterface -schema: 2.0.0 ---- - -# Set-AzureRmNetworkInterface - -## SYNOPSIS -Sets the goal state for a network interface. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkInterface -NetworkInterface <PSNetworkInterface> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkInterface** sets the goal state for an Azure network interface. - -## EXAMPLES - -### Example 1: Configure a network interface -``` -$Nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$Nic.IpConfigurations[0].PrivateIpAddress = "10.0.1.20" -$Nic.IpConfigurations[0].PrivateIpAllocationMethod = "Static" -$Nic.Tag = @{Name = "Name"; Value = "Value"} -Set-AzureRmNetworkInterface -NetworkInterface $Nic -``` - -This example configures a network interface. -The first command gets a network interface named NetworkInterface1 in resource group ResourceGroup1. -The second command sets the private IP address of the IP configuration. -The third command sets the private IP allocation method to Static. -The fourth command sets a tag on the network interface. -The fifth command uses the information stored in the $Nic variable to set the network interface. - -### Example 2: Change DNS settings on a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nic.DnsSettings.DnsServers.Add("192.168.1.100") -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets a network interface named NetworkInterface1 that exists within resource group ResourceGroup1. The second command adds DNS server 192.168.1.100 to this interface. The third command applies these changes to the network interface. To remove a DNS server, follow the commands listed above, but replace ".Add" with ".Remove" in the second command. - -### Example 3: Enable IP forwading on a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nic.EnableIPForwarding = 1 -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command changes the IP forwarding value to true. Finally, the third command applies the changes to the network interface. To disable IP forwarding on a network interface, follow the sample example, but be sure to change the second command to "$nic.EnableIPForwarding = 0". - -### Example 4: Change the subnet of a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$vnet = Get-AzureRmVirtualNetwork -Name VNet1 -ResourceGroupName crosssubcrossversionpeering -$subnet2 = Get-AzureRmVirtualNetworkSubnetConfig -Name Subnet2 -VirtualNetwork $vnet -$nic.IpConfigurations[0].Subnet.Id = $subnet2.Id -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets the network interface NetworkInterface1 and stores it in the $nic variable. The second command gets the virtual network associated with the subnet that the network interface is going to be associated with. The second command gets the subnet and stores it in the $subnet2 variable. The third command associated the primary private IP address of the network interface with the new subnet. Finally the last command applied these changes on the network interface. - ->[!NOTE] ->The IP configurations must be dynamic before you can change the subnet. If you have static IP configurations, change then to dynamic before proceeding. - ->[!NOTE] ->If the network interface has multiple IP configurations, the forth command must be done for all these IP configurations before the final Set-AzureRmNetworkInterface command is executed. This can be done as in the forth command but by replacing "0" with the appropriate number. If a network interface has N IP configurations, then N-1 of these commands must exist. - -### Example 5: Associate/Dissociate a Network Security Group to a network interface -``` -$nic = Get-AzureRmNetworkInterface -ResourceGroupName "ResourceGroup1" -Name "NetworkInterface1" -$nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName "ResourceGroup1" -Name "MyNSG" -$nic.NetworkSecurityGroup = $nsg -$nic | Set-AzureRmNetworkInterface -``` - -The first command gets an existing network interface called NetworkInterface1 and stores it in the $nic variable. The second command gets an existing network security group called MyNSG and stores it in the $nsg variable. The forth command assigns the $nsg to the $nic. Finally, the fifth command applies the changes to the Network interface. To dissociate network security groups from a network interface, simple replace $nsg in the forth command with $null. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object that represents the goal state for a network interface. - -```yaml -Type: PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkInterface -Parameter 'NetworkInterface' accepts value of type 'PSNetworkInterface' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[Get-AzureRmNetworkInterface](./Get-AzureRmNetworkInterface.md) - -[New-AzureRmNetworkInterface](./New-AzureRmNetworkInterface.md) - -[Remove-AzureRmNetworkInterface](./Remove-AzureRmNetworkInterface.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterfaceIpConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterfaceIpConfig.md deleted file mode 100644 index 9fec7e931e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkInterfaceIpConfig.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 13EF1028-43DE-424D-8185-EC45B5CEF2C1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkinterfaceipconfig -schema: 2.0.0 ---- - -# Set-AzureRmNetworkInterfaceIpConfig - -## SYNOPSIS -Sets the goal state for an Azure network interface IP configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-Subnet <PSSubnet>] - [-PublicIpAddress <PSPublicIpAddress>] - [-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>] - [-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>] - [-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>] - [-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkInterfaceIpConfig -Name <String> -NetworkInterface <PSNetworkInterface> - [-PrivateIpAddressVersion <String>] [-PrivateIpAddress <String>] [-Primary] [-SubnetId <String>] - [-PublicIpAddressId <String>] - [-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>] - [-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkInterfaceIpConfig** cmdlet sets the goal state for an Azure network interface IP configuration. - -## EXAMPLES - -### 1: Changing the IP address of an IP configuration -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet - -$nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet - -Primary - -$nic | Set-AzureRmNetworkInterface -``` - -The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the - variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP - configuration that needs to be updated. The third command sets the private IP address of the primary IP - configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes - have been made successfully. - - -### 2: Associating an IP configuration with an applicaiton security groupp -``` -$vnet = Get-AzureRmVirtualNetwork -Name myvnet -ResourceGroupName myrg -$subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet -$asg = Get-ApplicationSecurityGroup -Name myasg -ResourceGroupName myrg - -$nic = Get-AzureRmNetworkInterface -Name nic1 -ResourceGroupName myrg - -$nic | Set-AzureRmNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -ApplicationSecurityGroup $asg - -Primary - -$nic | Set-AzureRmNetworkInterface -``` - -In this example, the variable $asg contains a reference to an application security group. - The fourth command gets the network interface nic1 associated with the IP - configuration that needs to be updated. The Set-AzureRmNetworkInterfaceIpConfig sets the private IP address of the primary IP - configuration ipconfig1 to 10.0.0.11 and creates an association with the retrieved application security group. - Finally, the last command updates the network interface ensuring the changes - have been made successfully. - -## PARAMETERS - -### -ApplicationGatewayBackendAddressPool -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationGatewayBackendAddressPoolId -Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroup -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationSecurityGroupId -Specifies a collection of application security group references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPool -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerBackendAddressPoolId -Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRule -Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadBalancerInboundNatRuleId -Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network IP configuration for which this cmdlet sets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkInterface -Specifies a **NetworkInterface** object. -This cmdlet adds a network interface IP configuration to the object that this parameter specifies. - -```yaml -Type: PSNetworkInterface -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Primary -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddress -Specifies the static IP address of the network interface IP configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateIpAddressVersion -Specifies the IP address version of a network interface IP configuration. -The acceptable values for this parameter are: - -- IPv4 -- IPv6 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIPAddress** object. -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddressId -This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a **Subnet** object. -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: PSSubnet -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -This cmdlet creates a reference to a subnet in which this network interface IP configuration is created. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkInterface -Parameter 'NetworkInterface' accepts value of type 'PSNetworkInterface' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkInterface - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Add-AzureRmNetworkInterfaceIpConfig](./Add-AzureRmNetworkInterfaceIpConfig.md) - -[Get-AzureRmNetworkInterfaceIpConfig](./Get-AzureRmNetworkInterfaceIpConfig.md) - -[New-AzureRmNetworkInterfaceIpConfig](./New-AzureRmNetworkInterfaceIpConfig.md) - -[Remove-AzureRmNetworkInterfaceIpConfig](./Remove-AzureRmNetworkInterfaceIpConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityGroup.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityGroup.md deleted file mode 100644 index fcbb68c743..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityGroup.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 9F69DAEF-F2ED-449B-B75F-FCA7ED73D98F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworksecuritygroup -schema: 2.0.0 ---- - -# Set-AzureRmNetworkSecurityGroup - -## SYNOPSIS -Sets the goal state for a network security group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmNetworkSecurityGroup -NetworkSecurityGroup <PSNetworkSecurityGroup> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkSecurityGroup** cmdlet sets the goal state for an Azure network security group. - -## EXAMPLES - -### Example 1: Set the goal state for a network security group -``` -PS C:\>Get-AzureRmNetworkSecurityGroup -Name "Nsg1" -ResourceGroupName "Rg1" | Add-AzureRmNetworkSecurityRuleConfig -Name "Rdp-Rule" -Description "Allow RDP" -Access "Allow" -Protocol "Tcp" -Direction "Inbound" -Priority 100 -SourceAddressPrefix "Internet" -SourcePortRange "*" -DestinationAddressPrefix "*" -DestinationPortRange "3389" | Set-AzureRmNetworkSecurityGroup -``` - -This command gets the Azure network security group named Nsg1, and adds a network security rule named Rdp-Rule to allow Internet traffic on port 3389 to the retrieved network security group object using Add-AzureRmNetworkSecurityRuleConfig. -The command persists the modified Azure network security group using **Set-AzureRmNetworkSecurityGroup**. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -A network security group object representing the goal state to which the cmdlet sets the network security group. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkSecurityGroup -Parameter 'NetworkSecurityGroup' accepts value of type 'PSNetworkSecurityGroup' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmNetworkSecurityGroup](./Get-AzureRmNetworkSecurityGroup.md) - -[New-AzureRmNetworkSecurityGroup](./New-AzureRmNetworkSecurityGroup.md) - -[Remove-AzureRmNetworkSecurityGroup](./Remove-AzureRmNetworkSecurityGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityRuleConfig.md deleted file mode 100644 index c4e3eff95f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkSecurityRuleConfig.md +++ /dev/null @@ -1,368 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 7EFFFF43-501E-4955-A4EE-2C09B8863B30 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworksecurityruleconfig -schema: 2.0.0 ---- - -# Set-AzureRmNetworkSecurityRuleConfig - -## SYNOPSIS -Sets the goal state for a network security rule configuration. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-DestinationApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>] - [-Access <String>] [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkSecurityRuleConfig -Name <String> -NetworkSecurityGroup <PSNetworkSecurityGroup> - [-Description <String>] [-Protocol <String>] - [-SourcePortRange <System.Collections.Generic.List`1[System.String]>] - [-DestinationPortRange <System.Collections.Generic.List`1[System.String]>] - [-SourceAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-DestinationAddressPrefix <System.Collections.Generic.List`1[System.String]>] - [-SourceApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] - [-DestinationApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>] [-Access <String>] - [-Priority <Int32>] [-Direction <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmNetworkSecurityRuleConfig** cmdlet sets the goal state for an Azure network security rule configuration. - -## EXAMPLES - -### Example 1: Change the access configuration in a network security rule -``` -PS C:\>$nsg = Get-AzureRmNetworkSecurityGroup -Name "NSG-FrontEnd" -ResourceGroupName "TestRG" -PS C:\> $nsg | Get-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -PS C:\> Set-AzureRmNetworkSecurityRuleConfig -Name "rdp-rule" -NetworkSecurityGroup $nsg -Access "Deny" -``` - -The first command gets the network security group named NSG-FrontEnd, and then stores it in the variable $nsg. - -The second command uses the pipeline operator to pass the security group in $nsg to Get-AzureRmNetworkSecurityRuleConfig, which gets the security rule configuration named rdp-rule. - -The third command changes the access configuration of rdp-rule to Deny. - -## PARAMETERS - -### -Access -Specifies whether network traffic is allowed or denied. -The acceptable values for this parameter are: Allow and Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a rule configuration. -The maximum size is 140 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddressPrefix -Specifies a destination address prefix. -The acceptable values for this parameter are: - -- A Classless Interdomain Routing (CIDR) address -- A destination IP address range -- A wildcard character (*) to match any IP address - -You can use tags such as VirtualNetwork, AzureLoadBalancer, and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroup -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationApplicationSecurityGroupId -The application security group set as destination for the rule. It cannot be used with 'DestinationAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPortRange -Specifies a destination port or range. -The acceptable values for this parameter are: - -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies whether a rule is evaluated for incoming or outgoing traffic. -The acceptable values for this parameter are: Inbound and Outbound. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network security rule configuration that this cmdlet sets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies the **NetworkSecurityGroup** object that contains the network security rule configuration to set. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a rule configuration. -The acceptable values for this parameter are:An integer between 100 and 4096. - -The priority number must be unique for each rule in the collection. -The lower the priority number, the higher the priority of the rule. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the network protocol that a rule configuration applies to. -The acceptable values for this parameter are: - - --Tcp -- Udp -- A wildcard character (*) to match both - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Tcp, Udp, * - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAddressPrefix -Specifies a source address prefix. -The acceptable values for this parameter are: - -- A CIDR -- A source IP range -- A wildcard character (*) to match any IP address - -You can also use tags such as VirtualNetwork, AzureLoadBalancer and Internet. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroup -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup] -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplicationSecurityGroupId -The application security group set as source for the rule. It cannot be used with 'SourceAddressPrefix' parameter. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePortRange -Specifies the source port or range. -The acceptable values for this parameter are: - -- An integer -- A range of integers between 0 and 65535 -- A wildcard character (*) to match any port - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSNetworkSecurityGroup -Parameter 'NetworkSecurityGroup' accepts value of type 'PSNetworkSecurityGroup' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkSecurityGroup - -## NOTES - -## RELATED LINKS - -[Add-AzureRmNetworkSecurityRuleConfig](./Add-AzureRmNetworkSecurityRuleConfig.md) - -[Get-AzureRmNetworkSecurityRuleConfig](./Get-AzureRmNetworkSecurityRuleConfig.md) - -[New-AzureRmNetworkSecurityRuleConfig](./New-AzureRmNetworkSecurityRuleConfig.md) - -[Remove-AzureRmNetworkSecurityRuleConfig](./Remove-AzureRmNetworkSecurityRuleConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md deleted file mode 100644 index b54595ff16..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConfigFlowLog.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkwatcherconfigflowlog -schema: 2.0.0 ---- - -# Set-AzureRmNetworkWatcherConfigFlowLog - -## SYNOPSIS -Configures flow logging for a target resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher <PSNetworkWatcher> -TargetResourceId <String> - -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] [-RetentionInDays <Int32>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -EnableFlowLog <Boolean> -StorageAccountId <String> [-EnableRetention <Boolean>] - [-RetentionInDays <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmNetworkWatcherConfigFlowLog configures flow logging for a target resource. -Properties to configure include: whether or not flow logging is enabled for the resource provided, the configured storage account to send logs, and the retention policy for the logs. -Currently Network Security Groups are supported for flow logging. - -## EXAMPLES - -### --- Example 1: Configure Flow Logging for a Specified NSG --- -``` -PS C:\> $NW = Get-AzurermNetworkWatcher -ResourceGroupName NetworkWatcherRg -Name NetworkWatcher_westcentralus -PS C:\> $nsg = Get-AzureRmNetworkSecurityGroup -ResourceGroupName NSGRG -Name appNSG -PS C:\> $storageId = "/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123" - - -PS C:\> Set-AzureRmNetworkWatcherConfigFlowLog -NetworkWatcher $NW -TargetResourceId $nsg.Id -EnableFlowLog $true -StorageAccountId $storageID - -TargetResourceId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Network/networkSecurityGroups/appNSG -StorageId : /subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/NSGRG/providers/Microsoft.Storage/storageAccounts/contosostorageacct123 -Enabled : True -RetentionPolicy : { - "Days": 0, - "Enabled": false - } -``` - -In this example we configure flow logging status for a Network Security Group. In the response, we see the specified NSG has flow logging enabled, and no retention policy set. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFlowLog -Flag to enable/disable flow logging. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableRetention -Flag to enable/disable retention. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionInDays -Number of days to retain flow log records. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountId -ID of the storage account which is used to store the flow log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -The target resource ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -System.Boolean -System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSFlowLog - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, watcher, flow, logs, flowlog, logging - -## RELATED LINKS - -[Get-AzureRmNetworkWatcherFlowLogStatus](./Get-AzureRmNetworkWatcherFlowLogStatus.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 08117ddc4c..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,437 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermnetworkwatcherconfigflowlog -schema: 2.0.0 ---- - -# Set-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Update a connection monitor. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] - -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] -``` - -### SetByName -``` -Set-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] -``` - -### SetByLocation -``` -Set-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByResourceId -``` -Set-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-Name <String>] -SourceResourceId <String> - [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] [-DestinationResourceId <String>] - [-DestinationAddress <String>] [-DestinationPort <Int32>] [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByInputObject -``` -Set-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-Name <String>] - -SourceResourceId <String> [-MonitoringIntervalInSeconds <Int32>] [-SourcePort <Int32>] - [-DestinationResourceId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AutoStart <Boolean>] [-Tag <Hashtable>] [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -The Set-AzureRmNetworkWatcherConnectionMonitor cmdlet updates the specified connection monitor. - -## EXAMPLES - -### --------------- Example 1: Update a connection monitor --------------- -``` -PS C:\> Set-AzureRmNetworkWatcherConnectionMonitor -Location centraluseuap -Name cm -SourceResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm --DestinationAddress google.com -DestinationPort 80 -Tag @{"key1" = "value1"} - -Name : cm -Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGro - ups/NetworkWatcherRG/providers/Microsoft.Network/networkWatcher - s/NetworkWatcher_centraluseuap/connectionMonitors/cm -Etag : W/"5b2b20e8-0ce0-417e-9607-76208149bb67" -ProvisioningState : Succeeded -Source : { - "ResourceId": "/subscriptions/00000000-0000-0000-0000-0000000 - 00000/RgCentralUSEUAP/providers/Microsoft.Compute/virtualMach - ines/vm", - "Port": 0 - } -Destination : { - "Address": "google.com", - "Port": 80 - } -MonitoringIntervalInSeconds : 60 -AutoStart : True -StartTime : 1/12/2018 7:19:28 PM -MonitoringStatus : Running -Location : centraluseuap -Type : Microsoft.Network/networkWatchers/connectionMonitors -Tags : { - "key1": "value1" - } -``` - -In this example we update existing connection monitor by changing destinationAddress and adding tags. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoStart -Auto start. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The Ip address of the connection monitor destination. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Destination port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationResourceId -The ID of the connection monitor destination. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation if you want to overwrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MonitoringIntervalInSeconds -Monitoring interval in seconds. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePort -Source port. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceResourceId -The ID of the connection monitor source. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmPublicIpAddress.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmPublicIpAddress.md deleted file mode 100644 index 7840d2690e..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmPublicIpAddress.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EC798838-1850-4E88-B17F-D2F00F2D4EE9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermpublicipaddress -schema: 2.0.0 ---- - -# Set-AzureRmPublicIpAddress - -## SYNOPSIS -Sets the goal state for a public IP address. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmPublicIpAddress -PublicIpAddress <PSPublicIpAddress> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPublicIpAddress** cmdlet sets the goal state for a public IP address. - -## EXAMPLES - -### 1: Change allocation method of a public IP address -``` -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName - -PS C:\> $publicIp.PublicIpAllocationMethod = "Dynamic" - -PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp - -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - - First command gets the public IP address resource with name $publicIPName in the resource - group $rgName. - Second command sets the allocation method of the public IP address object to "Static". - Set-AzureRmPublicIPAddress command updates the public IP address resource with the - updated object, and modifies the allocation method to 'Static'. A public IP address gets - allocated immediately. - -### 2: Change DNS domain label of a public IP address -``` -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName - -PS C:\> $publicIp.DnsSettings.DomainNameLabel = "newdnsprefix" - -PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp - -PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName -``` - -First command gets the public IP address resource with name $publicIPName in the resource - group $rgName. - Second command sets the DomainNameLabel property to the required dns prefix. - Set-AzureRmPublicIPAddress command updates the public IP address resource with the - updated object. DomainNameLabel & Fqdn are modified as expected. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicIpAddress -Specifies a **PublicIpAddress** object that represents the goal state to which the public IP address should be set. - -```yaml -Type: PSPublicIpAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSPublicIpAddress -Parameter 'PublicIpAddress' accepts value of type 'PSPublicIpAddress' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPublicIpAddress](./Get-AzureRmPublicIpAddress.md) - -[New-AzureRmPublicIpAddress](./New-AzureRmPublicIpAddress.md) - -[Remove-AzureRmPublicIpAddress](./Remove-AzureRmPublicIpAddress.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteConfig.md deleted file mode 100644 index 2ca3afd61a..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteConfig.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 6E967F9C-949E-4485-9B57-FC4F523D5DC9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermrouteconfig -schema: 2.0.0 ---- - -# Set-AzureRmRouteConfig - -## SYNOPSIS -Sets the goal state for a route. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteConfig -RouteTable <PSRouteTable> [-AddressPrefix <String>] [-NextHopType <String>] - [-NextHopIpAddress <String>] [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRouteConfig** cmdlet sets the goal state for an Azure route. - -## EXAMPLES - -### Example 1: Modify a route -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Set-AzureRmRouteConfig -Name "Route02" -AddressPrefix 10.4.0.0/16 -NextHopType VnetLocal | Set-AzureRmRouteTable -Name : Routetable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"58c2922e-9efe-4554-a457-956ef44bc718" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/Routetable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "route02", - "Etag": "W/\"58c2922e-9efe-4554-a457-956ef44bc718\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/routeTables/routetable01/routes/route02", - "AddressPrefix": "10.4.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using the Get-AzureRmRouteTable cmdlet. -The command passes that table to the current cmdlet by using the pipeline operator. -The current cmdlet modifies the route named Route02, and then passes the result to the **Set-AzureRmRouteTable** cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AddressPrefix -Specifies the destination, in Classless Interdomain Routing (CIDR) format, to which the route applies. - -```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. - -```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 route that this cmdlet modifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextHopIpAddress -Specifies the IP address of a virtual appliance that you add to your Azure virtual network. -This route forwards packets to that address. -Specify this parameter only if you specify a value of VirtualAppliance for the *NextHopType* parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextHopType -Specifies how this route forwards packets. -The acceptable values for this parameter are: - -- Internet. -The default Internet gateway provided by Azure. -- None. -If you specify this value, the route does not forward packets. -- VirtualAppliance. -A virtual appliance that you add to your Azure virtual network. -- VirtualNetworkGateway. -An Azureserver-to-server virtual private network gateway. -- VnetLocal. -The local virtual network. -If you have two subnets, 10.1.0.0/16 and 10.2.0.0/16 in the same virtual network, select a value of VnetLocal for each subnet to forward to the other subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table with which this route is associated. - -```yaml -Type: PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteTable -Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteConfig](./Get-AzureRmRouteConfig.md) - -[New-AzureRmRouteConfig](./New-AzureRmRouteConfig.md) - -[Remove-AzureRmRouteConfig](./Remove-AzureRmRouteConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilter.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilter.md deleted file mode 100644 index 349db8f669..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilter.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutefilter -schema: 2.0.0 ---- - -# Set-AzureRmRouteFilter - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteFilter -RouteFilter <PSRouteFilter> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilterRuleConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilterRuleConfig.md deleted file mode 100644 index a982649064..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteFilterRuleConfig.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutefilterruleconfig -schema: 2.0.0 ---- - -# Set-AzureRmRouteFilterRuleConfig - -## SYNOPSIS -{{Fill in the Synopsis}} - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteFilterRuleConfig -RouteFilter <PSRouteFilter> [-Force] -Name <String> -Access <String> - -RouteFilterRuleType <String> -CommunityList <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -{{Fill in the Description}} - -## EXAMPLES - -### Example 1 -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Access -The access type of the rule. -Possible values are: 'Allow', 'Deny' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommunityList -The list of community value that route filter will filter on - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 if you want to overrite a resource - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the route filter rule - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteFilter -The RouteFilter - -```yaml -Type: PSRouteFilter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RouteFilterRuleType -The route filter rule type of the rule. -Possible values are: 'Community' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Community - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteFilter - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteTable.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteTable.md deleted file mode 100644 index 976a4a8b65..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmRouteTable.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 1CE2A30A-6DF8-4C4C-8348-C3C1CD4D0146 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermroutetable -schema: 2.0.0 ---- - -# Set-AzureRmRouteTable - -## SYNOPSIS -Sets the goal state for a route table. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmRouteTable -RouteTable <PSRouteTable> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmRouteTable** cmdlet sets the goal state for an Azure route table. - -## EXAMPLES - -### Example 1: Add a route and then set the goal state of the route table -``` -PS C:\>Get-AzureRmRouteTable -ResourceGroupName "ResourceGroup11" -Name "RouteTable01" | Add-AzureRmRouteConfig -Name "Route07" -AddressPrefix 10.2.0.0/16 -NextHopType "VnetLocal" | Set-AzureRmRouteTable -Name : RouteTable01 -ResourceGroupName : ResourceGroup11 -Location : eastus -Id : /subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Microsoft.Networ - k/routeTables/RouteTable01 -Etag : W/"f13e1bc8-d41f-44d0-882d-b8b5a1134f59" -ProvisioningState : Succeeded -Tags : -Routes : [ - { - "Name": "Route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/RouteTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.1.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "Route07", - "Etag": "W/\"f13e1bc8-d41f-44d0-882d-b8b5a1134f59\"", - "Id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/ResourceGroup11/providers/Micro - soft.Network/RouteTables/RouteTable01/routes/Route07", - "AddressPrefix": "10.2.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": "Succeeded" - }, - { - "Name": "Route13", - "Etag": null, - "Id": null, - "AddressPrefix": "10.3.0.0/16", - "NextHopType": "VnetLocal", - "NextHopIpAddress": null, - "ProvisioningState": null - } - ] -Subnets : [] -``` - -This command gets the route table named RouteTable01 by using Get-AzureRmRouteTable cmdlet. -The command passes that table to the Add-AzureRmRouteConfig cmdlet by using the pipeline operator. -**Add-AzureRmRouteConfig** adds the route named Route07, and then passes the result to the current cmdlet, which updates the table to reflect your changes. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteTable -Specifies a route table object that represents the goal state to which this cmdlet sets the route table. - -```yaml -Type: PSRouteTable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSRouteTable -Parameter 'RouteTable' accepts value of type 'PSRouteTable' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSRouteTable - -## NOTES - -## RELATED LINKS - -[Add-AzureRmRouteConfig](./Add-AzureRmRouteConfig.md) - -[Get-AzureRmRouteTable](./Get-AzureRmRouteTable.md) - -[New-AzureRmRouteTable](./New-AzureRmRouteTable.md) - -[Remove-AzureRmRouteTable](./Remove-AzureRmRouteTable.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetwork.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetwork.md deleted file mode 100644 index d60002a512..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetwork.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 93D8A341-540A-43F1-8C62-28323EAA58E0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetwork -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetwork - -## SYNOPSIS -Sets the goal state for a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetwork -VirtualNetwork <PSVirtualNetwork> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetwork** cmdlet sets the goal state for an Azure virtual network. - -## EXAMPLES - -### 1: Creates a virtual network and removes one of its subnets -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - $frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - -$backendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -AddressPrefix "10.0.2.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName - TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet,$backendSubnet - -Remove-AzureRmVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork - -$virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a virtual network with two subnets. Then it removes one subnet from - the in-memory representation of the virtual network. The Set-AzureRmVirtualNetwork cmdlet - is then used to write the modified virtual network state on the service side. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a **VirtualNetwork** object that represents the goal state. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - -[New-AzureRmVirtualNetwork](./New-AzureRmVirtualNetwork.md) - -[Remove-AzureRmVirtualNetwork](./Remove-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGateway.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGateway.md deleted file mode 100644 index 254af23cd8..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGateway.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 5C309071-A2ED-464C-9197-0A77859C8FBB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgateway -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkGateway - -## SYNOPSIS -Updates a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] - [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-EnableActiveActiveFeature] [-DisableActiveActiveFeature] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway <PSVirtualNetworkGateway> [-GatewaySku <String>] - [-GatewayDefaultSite <PSLocalNetworkGateway>] - [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>] - [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>] - [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>] - [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>] - [-Asn <UInt32>] [-PeerWeight <Int32>] [-EnableActiveActiveFeature] [-DisableActiveActiveFeature] - -RadiusServerAddress <String> -RadiusServerSecret <SecureString> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGateway** cmdlet updates a virtual network gateway. - -## EXAMPLES - -### Example 1: Set the goal state a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001" -PS C:\> Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337 -``` - -The first command gets a virtual network gateway named Gateway01 that belongs to resource group ResourceGroup001 and stores it to the variable named $Gateway - -The second command sets the goal state for the virtual network gateway stored in variable $Gateway. -The command also sets the ASN to 1337. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -Specifies the virtual network gateway Autonomous System Number (ASN) that is used to set up Border Gateway Protocol (BGP) sessions inside IPsec tunnels. - -```yaml -Type: UInt32 -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. -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableActiveActiveFeature -Disables the active-active feature. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableActiveActiveFeature -Enables the active-active feature. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GatewayDefaultSite -Specifies the default site to use for force tunneling. -If a default site is specified, all internet traffic from the gateway's Virtual Private Network (VPN) is routed to that site. - -```yaml -Type: PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GatewaySku -Specifies the stock keeping unit (SKU) of the virtual network gateway. -The acceptable values for this parameter are: - -- Basic -- Standard -- HighPerformance -- VpnGw1 -- VpnGw2 -- VpnGw3 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PeerWeight -Specifies the weight added to routes learned over BGP from this virtual network gateway - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerAddress -P2S External Radius server address. -```yaml -Type: String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. -```yaml -Type: SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies the virtual network gateway object to base modifications off of. -You can use the Get-AzureRmVirtualNetworkGateway cmdlet to get the virtual network gateway object. - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool -Specifies the address space that this cmdlet uses to allocate VPN client IP addresses from. -This should not overlap with virtual network or on-premise ranges. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientProtocol -A list of P2S VPN client tunneling protocols -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: -Accepted values: SSTP, IkeV2 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRevokedCertificates -Specifies a list of revoked VPN client certificates. -A VPN client presenting a certificate that matches one of these is removed. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VpnClientRootCertificates -Specifies a list of VPN client root certificates to use for VPN client authentication. -Connecting VPN clients must present certificates generated from one of these root certificates. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetworkGateway -Parameter 'VirtualNetworkGateway' accepts value of type 'PSVirtualNetworkGateway' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway - -## NOTES -* Keywords: azure, azurerm, arm, resource, management, manager, network, networking - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[New-AzureRmVirtualNetworkGateway](./New-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGateway](./Remove-AzureRmVirtualNetworkGateway.md) - -[Reset-AzureRmVirtualNetworkGateway](./Reset-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnection.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnection.md deleted file mode 100644 index 477346ed8d..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnection.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D7065B04-1A01-4BB4-A519-1DA9002CDE02 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayconnection -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkGatewayConnection - -## SYNOPSIS -Configures a virtual network gateway connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection> - [-EnableBgp <Boolean>] [-UsePolicyBasedTrafficSelectors <Boolean>] - [-IpsecPolicies <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>] - [-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayConnection** cmdlet configures a virtual network gateway connection. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableBgp -Whether to use a BGP session over a S2S VPN tunnel - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpsecPolicies -A list of IPSec policies. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UsePolicyBasedTrafficSelectors -Whether to use policy-based traffic selectors for a S2S connection - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkGatewayConnection -Specifies the PSVirtualNetworkGatewayConnection object that this cmdlet uses to modify the virtual network gateway connection. - -```yaml -Type: PSVirtualNetworkGatewayConnection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetworkGatewayConnection -Parameter 'VirtualNetworkGatewayConnection' accepts value of type 'PSVirtualNetworkGatewayConnection' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGatewayConnection - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnection](./Get-AzureRmVirtualNetworkGatewayConnection.md) - -[New-AzureRmVirtualNetworkGatewayConnection](./New-AzureRmVirtualNetworkGatewayConnection.md) - -[Remove-AzureRmVirtualNetworkGatewayConnection](./Remove-AzureRmVirtualNetworkGatewayConnection.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md deleted file mode 100644 index 04c9679986..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayConnectionSharedKey.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 78BADAF3-6001-4A25-A74D-F6B50079FCB4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayconnectionsharedkey -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkGatewayConnectionSharedKey - -## SYNOPSIS -Configures the shared key of the virtual network gateway connection. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayConnectionSharedKey -Name <String> -ResourceGroupName <String> -Value <String> - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayConnectionSharedKey** cmdlet configures the shared key of the virtual network gateway connection. - -## EXAMPLES - -### 1: -``` - -``` - -## 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network gateway shared key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the virtual network gateway belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the shared key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Get-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - -[Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey](./Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md deleted file mode 100644 index d9d6bdf688..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayDefaultSite.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: A27EE9C0-C7F5-4BF6-AE52-58087BD1B1C3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewaydefaultsite -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkGatewayDefaultSite - -## SYNOPSIS -Sets the default site for a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkGatewayDefaultSite -VirtualNetworkGateway <PSVirtualNetworkGateway> - -GatewayDefaultSite <PSLocalNetworkGateway> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet assigns a forced tunneling default site to a virtual network gateway. -Forced tunneling provides a way for you to redirect Internet-bound traffic from Azure virtual machines to your on-premises network; this enables you to inspect and audit traffic before releasing it. -Forced tunneling is carried out by using a virtual private network (VPN) tunnel; this tunnel requires a default site, a local gateway where all the Azure Internet-bound traffic is redirected. -**Set-AzureRmVirtualNetworkGatewayDefaultSite** provides a way to change the default site assigned to a gateway. - -## EXAMPLES - -### Example 1: Assign a default site to a virtual network gateway -``` -PS C:\>$LocalGateway = Get-AzureRmLocalNetworkGateway -Name "ContosoLocalGateway " -ResourceGroup "ContosoResourceGroup" -PS C:\> $VirtualGateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Set-AzureRmVirtualNetworkGatewayDefaultSite -GatewayDefaultSite $LocalGateway -VirtualNetworkGateway $VirtualGateway -``` - -This example assigns a default site to a virtual network gateway named ContosoVirtualGateway. - -The first command creates an object reference to a local gateway named ContosoLocalGateway. -This object reference that is stored in the variable named $LocalGateway represents the gateway to be configured as the default site - -. -The second command then creates an object reference to the virtual network gateway and stores the result in the variable named $VirtualGateway. - -The third command uses the **Set-AzureRmVirtualNetworkGatewayDefaultSite** cmdlet to assign the default site to ContosoVirtualGateway. - -## 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 -``` - -### -GatewayDefaultSite -Specifies an object reference to the local network gateway to be assigned as the default site for the specified virtual network. -You can use the Get-AzureRmLocalNetworkGateway cmdlet to create an object reference to a local gateway. - -```yaml -Type: PSLocalNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway where the default site will be assigned. -You can create an object reference to a virtual network gateway by using the **Get-AzureRmVirtualNetworkGateway** and specifying the name of the gateway. - -The variable $VirtualGateway can then be used as the parameter value for the *VirtualNetworkGateway* parameter: - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet accepts pipelined instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## OUTPUTS - -### -This cmdlet modifies existing instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmLocalNetworkGateway](./Get-AzureRmLocalNetworkGateway.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Remove-AzureRmVirtualNetworkGatewayDefaultSite](./Remove-AzureRmVirtualNetworkGatewayDefaultSite.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md deleted file mode 100644 index da3e4a0558..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkGatewayVpnClientConfig.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: EFB0D7A6-0C8A-4514-873D-672641CCCAF3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkgatewayvpnclientconfig -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkGatewayVpnClientConfig - -## SYNOPSIS -Sets the VPN client address pool for a virtual network gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### Default (Default) -``` -Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> - -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RadiusServerConfiguration -``` -Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway> - -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]> -RadiusServerAddress <String> - -RadiusServerSecret <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkVpnClientConfig** cmdlet configures the client address pool for a virtual network gateway. -Virtual private network (VPN) clients that connect to this gateway will be assigned an IP address from this address pool. - -## EXAMPLES - -### Example 1: Assign a VPN client address pool to a virtual network gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -``` - -This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. - -The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. - -The second command in the example then uses the **Set-AzureRmVirtualNetworkGatewayVpnClientConfig** cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. - -### Example 2: Configure external radius based authentication on existing gateway -``` -PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -PS C:\> $Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force -PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd -``` - -This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. - -The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. - -The second command in the example then uses the **Set-AzureRmVirtualNetworkGatewayVpnClientConfig** cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. It also configures the external radius server "TestRadiusServer" to be used for authentication for vpn clients. - -## 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 -``` - -### -RadiusServerAddress -P2S External Radius server address. - -```yaml -Type: String -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RadiusServerSecret -P2S External Radius server secret. - -```yaml -Type: SecureString -Parameter Sets: RadiusServerConfiguration -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkGateway -Specifies an object reference to the virtual network gateway that contains the VPN client configuration settings that this cmdlet modifies. -You can create an object reference to a virtual network gateway by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway. - -```yaml -Type: PSVirtualNetworkGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VpnClientAddressPool -Specifies the IP addresses to be assigned to clients connecting to this gateway - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -This cmdlet accepts pipelined instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## OUTPUTS - -### -This cmdlet modifies existing instances of the **Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway** object. - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVpnClientPackage](./Get-AzureRmVpnClientPackage.md) - -[Get-AzureRmVirtualNetworkGateway](./Get-AzureRmVirtualNetworkGateway.md) - -[Resize-AzureRmVirtualNetworkGateway](./Resize-AzureRmVirtualNetworkGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkPeering.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkPeering.md deleted file mode 100644 index a0d2f28887..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkPeering.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 06DAD751-3A43-4EF6-94C5-AA7AC1A67FC8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworkpeering -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkPeering - -## SYNOPSIS -Configures a virtual network peering. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering <PSVirtualNetworkPeering> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkPeering** cmdlet configures a virtual network peering. - -## EXAMPLES - -### Example 1: Change forwarded traffic configuration of a virtual network peering -``` -# Get the virtual network peering you want to update information for -Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup" -Name "myVnet1ToMyVnet2" - -# Change value of AllowForwardedTraffic property -$myVnet1ToMyVnet2.AllowForwardedTraffic = $True - -# Update the peering with changes made -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1ToMyVnet2 -``` - -### Example 2: Change virtual network access of a virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" - -# Change AllowVirtualNetworkAccess property -$myVnet1TomyVnet2.AllowVirtualNetworkAccess = $False - -# Update virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 -``` - -### Example 3: Change gateway transit property configuration of a virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "myResourceGroup" -Name "myVnet1TomyVnet2" - -# Change AllowGatewayTransit property -$myVnet1TomyVnet2.AllowGatewayTransit = $True - -# Update the virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $myVnet1TomyVnet2 -``` - -### Example 4: Use remote gateways in virtual network peering -``` -# Get the virtual network peering -$myVnet1TomyVnet2 = Get-AzureRmVirtualNetworkPeering -VirtualNetworkName "myVnet1" -ResourceGroupName "ResourceGroup001" -Name "myVnet1TomyVnet2" - -# Change the UseRemoteGateways property -$myVnet1TomyVnet2.UseRemoteGateways = $True - -# Update the virtual network peering -Set-AzureRmVirtualNetworkPeering -VirtualNetworkPeering $LinkToVNet2 -``` - -By changing this property to $True, your peer's VNet gateway can be used. -However, the peer VNet must have a gateway configured and **AllowGatewayTransit** must have a value of $True. - -This property cannot be used if a gateway has already been configured. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkPeering -Specifies the virtual network peering. - -```yaml -Type: PSVirtualNetworkPeering -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetworkPeering -Parameter 'VirtualNetworkPeering' accepts value of type 'PSVirtualNetworkPeering' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkPeering - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkPeering](./Add-AzureRmVirtualNetworkPeering.md) - -[Get-AzureRmVirtualNetworkPeering](./Get-AzureRmVirtualNetworkPeering.md) - -[Remove-AzureRmVirtualNetworkPeering](./Remove-AzureRmVirtualNetworkPeering.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkSubnetConfig.md b/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkSubnetConfig.md deleted file mode 100644 index 066a4160db..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Set-AzureRmVirtualNetworkSubnetConfig.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: D1D51DEF-05DE-45C4-9013-A02A5B248EAC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/set-azurermvirtualnetworksubnetconfig -schema: 2.0.0 ---- - -# Set-AzureRmVirtualNetworkSubnetConfig - -## SYNOPSIS -Configures the goal state for a subnet configuration in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Set-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String> - [-NetworkSecurityGroup <PSNetworkSecurityGroup>] [-RouteTable <PSRouteTable>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceId -``` -Set-AzureRmVirtualNetworkSubnetConfig -Name <String> -VirtualNetwork <PSVirtualNetwork> -AddressPrefix <String> - [-NetworkSecurityGroupId <String>] [-RouteTableId <String>] - [-ServiceEndpoint <System.Collections.Generic.List`1[System.String]>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmVirtualNetworkSubnetConfig** cmdlet configures the goal state for a subnet configuration in an Azure virtual network. - -## EXAMPLES - -### 1: Modify the address prefix of a subnet -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - -Set-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.3.0/23" - -$virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a virtual network with one subnet. Then is calls - Set-AzureRmVirtualNetworkSubnetConfig to modify the AddressPrefix of the subnet. This - only impacts the in-memory representation of the virtual network. - Set-AzureRmVirtualNetwork is then called to modify the virtual network in Azure. - -### 2: Add a network security group to a subnet -``` -New-AzureRmResourceGroup -Name TestResourceGroup -Location centralus - -$frontendSubnet = New-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24" - -$virtualNetwork = New-AzureRmVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup - -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet - -$rdpRule = New-AzureRmNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow - -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389 - -$networkSecurityGroup = New-AzureRmNetworkSecurityGroup -ResourceGroupName - TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule - -Set-AzureRmVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix - "10.0.1.0/24" -NetworkSecurityGroup $networkSecurityGroup - -$virtualNetwork | Set-AzureRmVirtualNetwork -``` - -This example creates a resource group with one virtual network containing just one - subnet. It then creates a network security group with an allow rule for RDP traffic. The - Set-AzureRmVirtualNetworkSubnetConfig cmdlet is used to modify the in-memory - representation of the frontend subnet so that it points to the newly created network - security group. The Set-AzureRmVirtualNetwork cmdlet is then called to write the modified - state back to the service. - -## PARAMETERS - -### -AddressPrefix -Specifies a range of IP addresses for a subnet configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 a subnet configuration that this cmdlet configures. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSecurityGroup -Specifies a **NetworkSecurityGroup** object. - -```yaml -Type: PSNetworkSecurityGroup -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkSecurityGroupId -Specifies the ID of a network security group. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTable -Specifies the route table object that is associated with the network security group. - -```yaml -Type: PSRouteTable -Parameter Sets: SetByResource -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RouteTableId -Specifies the ID of the route table object that is associated with the network security group. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceEndpoint -Service Endpoint Value - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies the **VirtualNetwork** object that contains the subnet configuration. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork - -## NOTES - -## RELATED LINKS - -[Add-AzureRmVirtualNetworkSubnetConfig](./Add-AzureRmVirtualNetworkSubnetConfig.md) - -[Get-AzureRmVirtualNetworkSubnetConfig](./Get-AzureRmVirtualNetworkSubnetConfig.md) - -[New-AzureRmVirtualNetworkSubnetConfig](./New-AzureRmVirtualNetworkSubnetConfig.md) - -[Remove-AzureRmVirtualNetworkSubnetConfig](./Remove-AzureRmVirtualNetworkSubnetConfig.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/Start-AzureRmApplicationGateway.md deleted file mode 100644 index e16ccbd186..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmApplicationGateway.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 95731734-EDCA-432A-A7BF-94D1E3725FB2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermapplicationgateway -schema: 2.0.0 ---- - -# Start-AzureRmApplicationGateway - -## SYNOPSIS -Starts an application gateway. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Start-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmApplicationGateway** cmdlet starts an Azure application gateway - -## EXAMPLES - -### Example1: Start an application gateway -``` -PS C:\>$AppGw = Start-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command starts the application gateway stored in the $AppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway that this cmdlet starts. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Stop-AzureRmApplicationGateway](./Stop-AzureRmApplicationGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index 60872c39e0..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermapplicationgateway -schema: 2.0.0 ---- - -# Start-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Start a connection monitor - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByName -``` -Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByLocation -``` -Start-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByResourceId -``` -Start-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByInputObject -``` -Start-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-Name <String>] - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -The Start-AzureRmNetworkWatcherConnectionMonitor cmdlet starts the specified connection monitor. - -## EXAMPLES - -### --------------- Example 1: Start a connection monitor --------------- -``` -PS C:\> Start-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName NetworkWatcher_centraluseuap -ResourceGroupName NetworkWatcherRG -Name cm -``` - -In this example we start connection monitor specified by name and network watcher - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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 -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## OUTPUTS - -### System.Boolean - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) -[Stop-AzureRmNetworkWatcherConnectionMonitor](./Stop-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md b/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md deleted file mode 100644 index 51bdb76eb6..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Start-AzureRmNetworkWatcherResourceTroubleshooting.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/start-azurermnetworkwatcherresourcetroubleshooting -schema: 2.0.0 ---- - -# Start-AzureRmNetworkWatcherResourceTroubleshooting - -## SYNOPSIS -Starts troubleshooting on a Networking resource in Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher <PSNetworkWatcher> - -TargetResourceId <String> -StorageId <String> -StoragePath <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetResourceId <String> -StorageId <String> -StoragePath <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Start-AzureRmNetworkWatcherResourceTroubleshooting cmdlet starts troubleshooting for a Networking resource in Azure and returns information about potential issues and mitigations. Currently Virtual Network Gateways and Connections are supported. - -## EXAMPLES - -### --- Example 1: Start Troubleshooting on a Virtual Network Gateway --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName - -$target = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{vnetGatewayName}' -$storageId = '/subscriptions/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{storageAccountName}' -$storagePath = 'https://{storageAccountName}.blob.core.windows.net/troubleshoot' - -Start-AzureRmNetworkWatcherResourceTroubleshooting -NetworkWatcher $networkWatcher -TargetResourceId $target -StorageId $storageId -StoragePath $storagePath -``` - -The above sample starts troubleshooting on a virtual network gateway. The operation may take a few minutes to complete. - -## 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 -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageId -The storage ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoragePath -The storage path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetResourceId -Specifies the resource id of the resource to troubleshoot. Example format: "/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.Network/connections/${connectionName}" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSViewNsgRules - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, troubleshoot, VPN, connection - -## RELATED LINKS - -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmApplicationGateway.md b/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmApplicationGateway.md deleted file mode 100644 index 8390f4c2aa..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmApplicationGateway.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 2C9609E8-0D8B-471B-9F0E-672BF55C3A0E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermapplicationgateway -schema: 2.0.0 ---- - -# Stop-AzureRmApplicationGateway - -## SYNOPSIS -Stops an application gateway - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Stop-AzureRmApplicationGateway -ApplicationGateway <PSApplicationGateway> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmApplicationGateway** cmdlet stops an application gateway. - -## EXAMPLES - -### Example 1: Stop an application gateway -``` -PS C:\>Stop-AzureRmApplicationGateway -ApplicationGateway $AppGw -``` - -This command stops the application gateway stored in the $AppGw variable. - -## PARAMETERS - -### -ApplicationGateway -Specifies the application gateway that this cmdlet stops. - -```yaml -Type: PSApplicationGateway -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway - -## NOTES - -## RELATED LINKS - -[Get-AzureRmApplicationGateway](./Get-AzureRmApplicationGateway.md) - -[New-AzureRmApplicationGateway](./New-AzureRmApplicationGateway.md) - -[Remove-AzureRmApplicationGateway](./Remove-AzureRmApplicationGateway.md) - -[Set-AzureRmApplicationGateway](./Set-AzureRmApplicationGateway.md) - -[Start-AzureRmApplicationGateway](./Start-AzureRmApplicationGateway.md) - - diff --git a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md b/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md deleted file mode 100644 index a10e1dc24b..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherConnectionMonitor.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermapplicationgateway -schema: 2.0.0 ---- - -# Stop-AzureRmNetworkWatcherConnectionMonitor - -## SYNOPSIS -Stop a connection monitor - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher <PSNetworkWatcher> [-Name <String>] [-PassThru] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByName -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcherName <String> -ResourceGroupName <String> - [-Name <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByLocation -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -Location <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByResourceId -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -ResourceId <String> [-Name <String>] [-PassThru] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -### SetByInputObject -``` -Stop-AzureRmNetworkWatcherConnectionMonitor -InputObject <PSConnectionMonitorResult> [-Name <String>] - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] -``` - -## DESCRIPTION -The Stop-AzureRmNetworkWatcherConnectionMonitor cmdlet stops the specified connection monitor. - -## EXAMPLES - -### --------------- Example 1: Stop a connection monitor --------------- -``` -PS C:\> Stop-AzureRmNetworkWatcherConnectionMonitor -NetworkWatcher $nw -Name cm -``` - -In this example we stop connection monitor specified by name and network watcher - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Connection monitor object. - -```yaml -Type: PSConnectionMonitorResult -Parameter Sets: SetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Location of the network watcher. - -```yaml -Type: String -Parameter Sets: SetByLocation -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The connection monitor name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ConnectionMonitorName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Resource ID. - -```yaml -Type: String -Parameter Sets: SetByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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 -``` - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -Microsoft.Azure.Commands.Network.Models.PSConnectionMonitorResult - - -## OUTPUTS - -### System.Boolean - - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher, connection monitor - -## RELATED LINKS -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcherConnectionMonitor](./New-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitor](./Get-AzureRmNetworkWatcherConnectionMonitor.md) -[Get-AzureRmNetworkWatcherConnectionMonitorReport](./Get-AzureRmNetworkWatcherConnectionMonitorReport.md) -[Remove-AzureRmNetworkWatcherConnectionMonitor](./Remove-AzureRmNetworkWatcherConnectionMonitor.md) -[Set-AzureRmNetworkWatcherConnectionMonitor](./Set-AzureRmNetworkWatcherConnectionMonitor.md) -[Start-AzureRmNetworkWatcherConnectionMonitor](./Start-AzureRmNetworkWatcherConnectionMonitor.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherPacketCapture.md b/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherPacketCapture.md deleted file mode 100644 index af1bab190f..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Stop-AzureRmNetworkWatcherPacketCapture.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/stop-azurermnetworkwatcherpacketcapture -schema: 2.0.0 ---- - -# Stop-AzureRmNetworkWatcherPacketCapture - -## SYNOPSIS -Stops a running packet capture session - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher <PSNetworkWatcher> -PacketCaptureName <String> - [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SetByName -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcherName <String> -ResourceGroupName <String> - -PacketCaptureName <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Stop-AzureRmNetworkWatcherPacketCapture stops a running packet capture session. After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. - -## EXAMPLES - -### --- Example 1: Stop a packet capture session --- -``` -Stop-AzureRmNetworkWatcherPacketCapture -NetworkWatcher $networkWatcher -PacketCaptureName "PacketCaptureTest" -``` - -In this example we stop a running packet capture session named "PacketCaptureTest". After the session is stopped, the packet capture file is uploaded to storage and/or saved locally on the VM depending on its configuration. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PacketCaptureName -The packet capture name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -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: False -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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, packet, capture, traffic - -## RELATED LINKS - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Test-AzureRmNetworkWatcherIPFlow](./Test-AzureRmNetworkWatcherIPFlow.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmDnsAvailability.md b/azurermps-2.5.0/AzureRm.Network/Test-AzureRmDnsAvailability.md deleted file mode 100644 index f4bfa7c699..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmDnsAvailability.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 556A9F12-DF72-468F-9C3F-A747CC70BD2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermdnsavailability -schema: 2.0.0 ---- - -# Test-AzureRmDnsAvailability - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Test-AzureRmDnsAvailability -DomainNameLabel <String> -Location <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -## EXAMPLES - -### 1: -``` - -``` - -## 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 -``` - -### -DomainNameLabel -```yaml -Type: String -Parameter Sets: (All) -Aliases: DomainQualifiedName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherConnectivity.md b/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherConnectivity.md deleted file mode 100644 index 29e41eb8db..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherConnectivity.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermnetworkwatcherconnectivity -schema: 2.0.0 ---- - -# Test-AzureRmNetworkWatcherConnectivity - -## SYNOPSIS -Returns connectivity information for a specified source VM and a destination. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcher <PSNetworkWatcher> -SourceId <String> - [-SourcePort <Int32>] [-DestinationId <String>] [-DestinationAddress <String>] [-DestinationPort <Int32>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcherName <String> -ResourceGroupName <String> - -SourceId <String> [-SourcePort <Int32>] [-DestinationId <String>] [-DestinationAddress <String>] - [-DestinationPort <Int32>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmNetworkWatcherConnectivity cmdlet returns connectivity information for a specified source VM and a destination. If connectivity between the source and destination cannot be established, the cmdlet returns details about the issue. - -## EXAMPLES - -### --------------- Example 1: Test Network Watcher Connectivity from a VM to a website --------------- -``` -Test-AzureRmNetworkWatcherConnectivity -NetworkWatcherName NetworkWatcher -ResourceGroupName NetworkWatcherRG -SourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Compute/virtualMachines/MultiTierApp0" -DestinationAddress "bing.com" -DestinationPort 80 - - -ConnectionStatus : Reachable -AvgLatencyInMs : 4 -MinLatencyInMs : 2 -MaxLatencyInMs : 15 -ProbesSent : 15 -ProbesFailed : 0 -Hops : [ - { - "Type": "Source", - "Id": "f8cff464-e13f-457f-a09e-4dcd53d38a85", - "Address": "10.1.1.4", - "ResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/provi iders/Microsoft.Network/networkInterfaces/appNic0/ipConfigurations/ipconfig1", - "NextHopIds": [ - "1034b1bf-0b1b-4f0a-93b2-900477f45485" - ], - "Issues": [] - }, - { - "Type": "Internet", - "Id": "1034b1bf-0b1b-4f0a-93b2-900477f45485", - "Address": "13.107.21.200", - "ResourceId": "Internet", - "NextHopIds": [], - "Issues": [] - } - ] -``` - -In this example we test connectivity from a VM in Azure to www.bing.com. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationAddress -The IP address or URI the resource to which a connection attempt will be made. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationId -The ID of the resource to which a connection attempt will be made. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPort -Port on which check connectivity will be performed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceId -The ID of the resource from which a connectivity check will be initiated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePort -The source port from which a connectivity check will be performed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String -System.Int32 - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSConnectivityInformation - -## NOTES -Keywords: azure, azurerm, arm, resource, connectivity, management, manager, network, networking, network watcher - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) -[Get-AzureRmNetworkWatcherTroubleshootingResult](./Get-AzureRmNetworkWatcherTroubleshootingResult.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherIPFlow.md b/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherIPFlow.md deleted file mode 100644 index 52df5ffafa..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmNetworkWatcherIPFlow.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermnetworkwatcheripflow -schema: 2.0.0 ---- - -# Test-AzureRmNetworkWatcherIPFlow - -## SYNOPSIS -Returns whether the packet is allowed or denied to or from a particular destination. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResource (Default) -``` -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcher <PSNetworkWatcher> -TargetVirtualMachineId <String> - -Direction <String> -Protocol <String> -RemoteIPAddress <String> -LocalIPAddress <String> -LocalPort <String> - [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByName -``` -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcherName <String> -ResourceGroupName <String> - -TargetVirtualMachineId <String> -Direction <String> -Protocol <String> -RemoteIPAddress <String> - -LocalIPAddress <String> -LocalPort <String> [-RemotePort <String>] [-TargetNetworkInterfaceId <String>] - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Test-AzureRmNetworkWatcherIPFlow cmdlet, for a specified VM resource and a packet with specified direction using local and remote, IP addresses and ports, returns whether the packet is allowed or denied. - -## EXAMPLES - -### --- Example 1: Run Test-AzureRmNetworkWatcherIPFlow --- -``` -$nw = Get-AzurermResource | Where {$_.ResourceType -eq "Microsoft.Network/networkWatchers" -and $_.Location -eq "WestCentralUS" } -$networkWatcher = Get-AzureRmNetworkWatcher -Name $nw.Name -ResourceGroupName $nw.ResourceGroupName -$VM = Get-AzurermVM -ResourceGroupName testResourceGroup -Name VM0 -$Nics = Get-AzureRmNetworkInterface | Where {$_.Id -eq $vm.NetworkInterfaceIDs.ForEach({$_})} - -Test-AzureRmNetworkWatcherIPFlow -NetworkWatcher $networkWatcher -TargetVirtualMachineId $VM.Id -Direction Outbound -Protocol TCP -LocalIPAddress $nics[0].IpConfigurations[0].PrivateIpAddress -LocalPort 6895 -RemoteIPAddress 204.79.197.200 -RemotePort 80 -``` - -Get's the Network Watcher in West Central US for this subscription, then gets the VM and it's associated Network Interfaces. -Then for the first Network Interface, runs Test-AzureRmNetworkWatcherIPFlow using the first IP from the first Network Interface for an outbound connection to an IP on the internet. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Direction. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalIPAddress -Local IP Address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalPort -Local Port. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkWatcher -The network watcher resource. - -```yaml -Type: PSNetworkWatcher -Parameter Sets: SetByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkWatcherName -The name of network watcher. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Protocol -Protocol. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: TCP, UDP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Remote IP Address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemotePort -Remote port. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the network watcher resource group. - -```yaml -Type: String -Parameter Sets: SetByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetNetworkInterfaceId -Target network interface Id. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualMachineId -The target virtual machine ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher -System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIPFlowVerifyResult - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, flow, ip - -## RELATED LINKS - -[New-AzureRmNetworkWatcher](./New-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcher](./Get-AzureRmNetworkWatcher.md) - -[Remove-AzureRmNetworkWatcher](./Remove-AzureRmNetworkWatcher.md) - -[Get-AzureRmNetworkWatcherNextHop](./Get-AzureRmNetworkWatcherNextHop.md) - -[Get-AzureRmNetworkWatcherSecurityGroupView](./Get-AzureRmNetworkWatcherSecurityGroupView.md) - -[Get-AzureRmNetworkWatcherTopology](./Get-AzureRmNetworkWatcherTopology.md) - -[Start-AzureRmNetworkWatcherResourceTroubleshooting](./Start-AzureRmNetworkWatcherResourceTroubleshooting.md) - -[New-AzureRmNetworkWatcherPacketCapture](./New-AzureRmNetworkWatcherPacketCapture.md) - -[New-AzureRmPacketCaptureFilterConfig](./New-AzureRmPacketCaptureFilterConfig.md) - -[Get-AzureRmNetworkWatcherPacketCapture](./Get-AzureRmNetworkWatcherPacketCapture.md) - -[Remove-AzureRmNetworkWatcherPacketCapture](./Remove-AzureRmNetworkWatcherPacketCapture.md) - -[Stop-AzureRmNetworkWatcherPacketCapture](./Stop-AzureRmNetworkWatcherPacketCapture.md) diff --git a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmPrivateIPAddressAvailability.md b/azurermps-2.5.0/AzureRm.Network/Test-AzureRmPrivateIPAddressAvailability.md deleted file mode 100644 index 2458e70a84..0000000000 --- a/azurermps-2.5.0/AzureRm.Network/Test-AzureRmPrivateIPAddressAvailability.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Network.dll-Help.xml -Module Name: AzureRM.Network -ms.assetid: 0780CB09-9C3B-468A-A718-3A646FE3D152 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.network/test-azurermprivateipaddressavailability -schema: 2.0.0 ---- - -# Test-AzureRmPrivateIPAddressAvailability - -## SYNOPSIS -Test availability of a private IP address in a virtual network. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### TestByResource -``` -Test-AzureRmPrivateIPAddressAvailability -VirtualNetwork <PSVirtualNetwork> -IPAddress <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### TestByResourceId -``` -Test-AzureRmPrivateIPAddressAvailability -ResourceGroupName <String> -VirtualNetworkName <String> - -IPAddress <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmPrivateIPAddressAvailability** cmdlet tests whether a specified private IP address is available in a virtual network. -This cmdlet returns a list of available private IP addresses if the requested private IP address is taken. - -## EXAMPLES - -### Example 1: Test whether an IP address is available using the pipeline -``` -PS C:\>Get-AzureRmVirtualNetwork -Name $vnetName -ResourceGroupName $rgname | Test-AzureRmPrivateIPAddressAvailability -IPAddress "10.0.1.10" -``` - -This command gets a virtual network and uses the pipeline operator to pass it to **Test-AzureRmPrivateIPAddressAvailability**, which tests whether the specified private IP address is available. - -## 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 -``` - -### -IPAddress -Specifies the IP address to test. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for the virtual network. - -```yaml -Type: String -Parameter Sets: TestByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetwork -Specifies a **PSVirtualNetwork** object. - -```yaml -Type: PSVirtualNetwork -Parameter Sets: TestByResource -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualNetworkName -Specifies the name of the virtual network. - -```yaml -Type: String -Parameter Sets: TestByResourceId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSVirtualNetwork -Parameter 'VirtualNetwork' accepts value of type 'PSVirtualNetwork' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.Network.Models.PSIPAddressAvailabilityResult - -## NOTES - -## RELATED LINKS - -[Get-AzureRmVirtualNetwork](./Get-AzureRmVirtualNetwork.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Add-AzureRmADGroupMember.md b/azurermps-2.5.0/AzureRm.Resources/Add-AzureRmADGroupMember.md deleted file mode 100644 index 02f8d17ebb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Add-AzureRmADGroupMember.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/add-azurermadgroupmember -schema: 2.0.0 ---- - -# Add-AzureRmADGroupMember - -## SYNOPSIS -Adds a user to an existing AD group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### MemberObjectIdWithGroupObjectId (Default) -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupDisplayName -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObject -``` -Add-AzureRmADGroupMember -MemberObjectId <Guid[]> -TargetGroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupDisplayNameParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectIdParameterSet -``` -Add-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -TargetGroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Adds a user to an existing AD group. - -## EXAMPLES - -### Example 1 - Add a user to a group by object id - -``` -PS C:\> Add-AzureRmADGroupMember -MemberObjectId D9076BBC-D62C-4105-9C78-A7F5BC4A3405 -TargetGroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -``` - -Adds the user with object id 'D9076BBC-D62C-4105-9C78-A7F5BC4A3405' to the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'. - -### Example 2 - Add a user to a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE | Add-AzureRmADGroupMember -MemberObjectId D9076BBC-D62C-4105-9C78-A7F5BC4A3405 -``` - -Gets the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' and pipes it to the Add-AzureRmADGroupMember cmdlet to add the user to that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberObjectId -The object id of the member. - -```yaml -Type: System.Guid[] -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberObjectIdWithGroupDisplayName, MemberObjectIdWithGroupObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberUserPrincipalName -The UPN of the member(s) to add to the group. - -```yaml -Type: System.String[] -Parameter Sets: MemberUPNWithGroupDisplayNameParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroupDisplayName -The display name of the group to add the member(s) to. - -```yaml -Type: System.String -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberUPNWithGroupDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGroupObject -The object representation of the group to add the member(s) to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: MemberObjectIdWithGroupObject, MemberUPNWithGroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetGroupObjectId -The object id of the group to add the member(s) to. - -```yaml -Type: System.Guid -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: TargetGroupObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/AzureRM.Resources.md b/azurermps-2.5.0/AzureRm.Resources/AzureRM.Resources.md deleted file mode 100644 index 6d45c2cd2c..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/AzureRM.Resources.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -Module Name: AzureRM.Resources -Module Guid: ab3ca893-26fe-44b0-bd3c-8933df144d7b -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources -Help Version: 5.5.2.0 -Locale: en-US ---- - -# AzureRM.Resources Module -## Description -This topic displays help topics for the Azure Resource Manager Cmdlets. - -## AzureRM.Resources Cmdlets -### [Add-AzureRmADGroupMember](Add-AzureRmADGroupMember.md) -Adds a user to an existing AD group. - -### [Export-AzureRmResourceGroup](Export-AzureRmResourceGroup.md) -Captures a resource group as a template and saves it to a file. - -### [Get-AzureRmADAppCredential](Get-AzureRmADAppCredential.md) -Retrieves a list of credentials associated with an application. - -### [Get-AzureRmADApplication](Get-AzureRmADApplication.md) -Lists existing azure active directory applications. - -### [Get-AzureRmADGroup](Get-AzureRmADGroup.md) -Filters active directory groups. - -### [Get-AzureRmADGroupMember](Get-AzureRmADGroupMember.md) -Lists members of an AD group in the current tenant. - -### [Get-AzureRmADServicePrincipal](Get-AzureRmADServicePrincipal.md) -Filters active directory service principals. - -### [Get-AzureRmADSpCredential](Get-AzureRmADSpCredential.md) -Retrieves a list of credentials associated with a service principal. - -### [Get-AzureRmADUser](Get-AzureRmADUser.md) -Filters active directory users. - -### [Get-AzureRmDeployment](Get-AzureRmDeployment.md) -Gets a deployment at subscription scope. - -### [Get-AzureRmDeploymentOperation](Get-AzureRmDeploymentOperation.md) -Gets the deployment operations for a deployment at subscription scope. - -### [Get-AzureRmLocation](Get-AzureRmLocation.md) -Gets all locations and the supported resource providers for each location. - -### [Get-AzureRmManagedApplication](Get-AzureRmManagedApplication.md) -Gets managed applications - -### [Get-AzureRmManagedApplicationDefinition](Get-AzureRmManagedApplicationDefinition.md) -Gets managed application definitions - -### [Get-AzureRmManagementGroup](Get-AzureRmManagementGroup.md) -Gets Management Group(s) - -### [Get-AzureRmPolicyAssignment](Get-AzureRmPolicyAssignment.md) -Gets policy assignments. - -### [Get-AzureRmPolicyDefinition](Get-AzureRmPolicyDefinition.md) -Gets policy definitions. - -### [Get-AzureRmPolicySetDefinition](Get-AzureRmPolicySetDefinition.md) -Gets policy set definitions. - -### [Get-AzureRmProviderFeature](Get-AzureRmProviderFeature.md) -Gets information about Azure provider features. - -### [Get-AzureRmProviderOperation](Get-AzureRmProviderOperation.md) -Gets the operations for an Azure resource provider that are securable using Azure RBAC. - -### [Get-AzureRmResource](Get-AzureRmResource.md) -Gets resources. - -### [Get-AzureRmResourceGroup](Get-AzureRmResourceGroup.md) -Gets resource groups. - -### [Get-AzureRmResourceGroupDeployment](Get-AzureRmResourceGroupDeployment.md) -Gets the deployments in a resource group. - -### [Get-AzureRmResourceGroupDeploymentOperation](Get-AzureRmResourceGroupDeploymentOperation.md) -Gets the resource group deployment operation - -### [Get-AzureRmResourceLock](Get-AzureRmResourceLock.md) -Gets a resource lock. - -### [Get-AzureRmResourceProvider](Get-AzureRmResourceProvider.md) -Gets a resource provider. - -### [Get-AzureRmRoleAssignment](Get-AzureRmRoleAssignment.md) -Lists Azure RBAC role assignments at the specified scope. -By default it lists all role assignments in the selected Azure subscription. -Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. - -### [Get-AzureRmRoleDefinition](Get-AzureRmRoleDefinition.md) -Lists all Azure RBAC roles that are available for assignment. - -### [Invoke-AzureRmResourceAction](Invoke-AzureRmResourceAction.md) -Invokes an action on a resource. - -### [Move-AzureRmResource](Move-AzureRmResource.md) -Moves a resource to a different resource group or subscription. - -### [New-AzureRmADAppCredential](New-AzureRmADAppCredential.md) -Adds a credential to an existing application. - -### [New-AzureRmADApplication](New-AzureRmADApplication.md) -Creates a new azure active directory application. - -### [New-AzureRmADGroup](New-AzureRmADGroup.md) -Creates a new active directory group. - -### [New-AzureRmADServicePrincipal](New-AzureRmADServicePrincipal.md) -Creates a new azure active directory service principal. - -### [New-AzureRmADSpCredential](New-AzureRmADSpCredential.md) -Adds a credential to an existing service principal. - -### [New-AzureRmADUser](New-AzureRmADUser.md) -Creates a new active directory user. - -### [New-AzureRmDeployment](New-AzureRmDeployment.md) -Creates a new deployment at subscription scope. - -### [New-AzureRmManagedApplication](New-AzureRmManagedApplication.md) -Creates an Azure managed application. - -### [New-AzureRmManagedApplicationDefinition](New-AzureRmManagedApplicationDefinition.md) -Creates a managed application definition. - -### [New-AzureRmManagementGroup](New-AzureRmManagementGroup.md) -Creates a Management Group - -### [New-AzureRmManagementGroupSubscription](New-AzureRmManagementGroupSubscription.md) -Adds a Subscription to a Management Group. - -### [New-AzureRmPolicyAssignment](New-AzureRmPolicyAssignment.md) -Creates a policy assignment. - -### [New-AzureRmPolicyDefinition](New-AzureRmPolicyDefinition.md) -Creates a policy definition. - -### [New-AzureRmPolicySetDefinition](New-AzureRmPolicySetDefinition.md) -Creates a policy set definition. - -### [New-AzureRmResource](New-AzureRmResource.md) -Creates a resource. - -### [New-AzureRmResourceGroup](New-AzureRmResourceGroup.md) -Creates an Azure resource group. - -### [New-AzureRmResourceGroupDeployment](New-AzureRmResourceGroupDeployment.md) -Adds an Azure deployment to a resource group. - -### [New-AzureRmResourceLock](New-AzureRmResourceLock.md) -Creates a resource lock. - -### [New-AzureRmRoleAssignment](New-AzureRmRoleAssignment.md) -Assigns the specified RBAC role to the specified principal, at the specified scope. - -### [New-AzureRmRoleDefinition](New-AzureRmRoleDefinition.md) -Creates a custom role in Azure RBAC. -Provide either a JSON role definition file or a PSRoleDefinition object as input. -First, use the Get-AzureRmRoleDefinition command to generate a baseline role definition object. -Then, modify its properties as required. -Finally, use this command to create a custom role using role definition. - -### [Register-AzureRmProviderFeature](Register-AzureRmProviderFeature.md) -Registers an Azure provider feature in your account. - -### [Register-AzureRmResourceProvider](Register-AzureRmResourceProvider.md) -Registers a resource provider. - -### [Remove-AzureRmADAppCredential](Remove-AzureRmADAppCredential.md) -Removes a credential from an application. - -### [Remove-AzureRmADApplication](Remove-AzureRmADApplication.md) -Deletes the azure active directory application. - -### [Remove-AzureRmADGroup](Remove-AzureRmADGroup.md) -Deletes an active directory group. - -### [Remove-AzureRmADGroupMember](Remove-AzureRmADGroupMember.md) -Removes a user from an AD group. - -### [Remove-AzureRmADServicePrincipal](Remove-AzureRmADServicePrincipal.md) -Deletes the azure active directory service principal. - -### [Remove-AzureRmADSpCredential](Remove-AzureRmADSpCredential.md) -Removes a credential from a service principal. - -### [Remove-AzureRmADUser](Remove-AzureRmADUser.md) -Deletes an active directory user. - -### [Remove-AzureRmDeployment](Remove-AzureRmDeployment.md) -Removes a deployment at subscription scope. - -### [Remove-AzureRmManagedApplication](Remove-AzureRmManagedApplication.md) -Removes a managed application - -### [Remove-AzureRmManagedApplicationDefinition](Remove-AzureRmManagedApplicationDefinition.md) -Removes a managed application definition - -### [Remove-AzureRmManagementGroup](Remove-AzureRmManagementGroup.md) -Removes a Management Group - -### [Remove-AzureRmManagementGroupSubscription](Remove-AzureRmManagementGroupSubscription.md) -Removes a Subscription from a Management Group. - -### [Remove-AzureRmPolicyAssignment](Remove-AzureRmPolicyAssignment.md) -Removes a policy assignment. - -### [Remove-AzureRmPolicyDefinition](Remove-AzureRmPolicyDefinition.md) -Removes a policy definition. - -### [Remove-AzureRmPolicySetDefinition](Remove-AzureRmPolicySetDefinition.md) -Removes a policy set definition. - -### [Remove-AzureRmResource](Remove-AzureRmResource.md) -Removes a resource. - -### [Remove-AzureRmResourceGroup](Remove-AzureRmResourceGroup.md) -Removes a resource group. - -### [Remove-AzureRmResourceGroupDeployment](Remove-AzureRmResourceGroupDeployment.md) -Removes a resource group deployment and any associated operations. - -### [Remove-AzureRmResourceLock](Remove-AzureRmResourceLock.md) -Removes a resource lock. - -### [Remove-AzureRmRoleAssignment](Remove-AzureRmRoleAssignment.md) -Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. - -### [Remove-AzureRmRoleDefinition](Remove-AzureRmRoleDefinition.md) -Deletes a custom role in Azure RBAC. -The role to be deleted is specified using the Id property of the role. -Delete will fail if there are existing role assignments made to the custom role. - -### [Save-AzureRmDeploymentTemplate](Save-AzureRmDeploymentTemplate.md) -Gets the template for a deployment at subscription scope. - -### [Save-AzureRmResourceGroupDeploymentTemplate](Save-AzureRmResourceGroupDeploymentTemplate.md) -Saves a resource group deployment template to a file. - -### [Set-AzureRmManagedApplication](Set-AzureRmManagedApplication.md) -Updates managed application - -### [Set-AzureRmManagedApplicationDefinition](Set-AzureRmManagedApplicationDefinition.md) -Updates managed application definition - -### [Set-AzureRmPolicyAssignment](Set-AzureRmPolicyAssignment.md) -Modifies a policy assignment. - -### [Set-AzureRmPolicyDefinition](Set-AzureRmPolicyDefinition.md) -Modifies a policy definition. - -### [Set-AzureRmPolicySetDefinition](Set-AzureRmPolicySetDefinition.md) -Modifies a policy set definition - -### [Set-AzureRmResource](Set-AzureRmResource.md) -Modifies a resource. - -### [Set-AzureRmResourceGroup](Set-AzureRmResourceGroup.md) -Modifies a resource group. - -### [Set-AzureRmResourceLock](Set-AzureRmResourceLock.md) -Modifies a resource lock. - -### [Set-AzureRmRoleDefinition](Set-AzureRmRoleDefinition.md) -Modifies a custom role in Azure RBAC. -Provide the modified role definition either as a JSON file or as a PSRoleDefinition. -First, use the Get-AzureRmRoleDefinition command to retrieve the custom role that you wish to modify. -Then, modify the properties that you wish to change. -Finally, save the role definition using this command. - -### [Stop-AzureRmDeployment](Stop-AzureRmDeployment.md) -Cancels a running deployment at subscription scope. - -### [Stop-AzureRmResourceGroupDeployment](Stop-AzureRmResourceGroupDeployment.md) -Cancels a resource group deployment. - -### [Test-AzureRmDeployment](Test-AzureRmDeployment.md) -Validates a deployment template and parameters at subscription scope. - -### [Test-AzureRmResourceGroupDeployment](Test-AzureRmResourceGroupDeployment.md) -Validates a resource group deployment. - -### [Unregister-AzureRmResourceProvider](Unregister-AzureRmResourceProvider.md) -Unregisters a resource provider. - -### [Update-AzureRmADApplication](Update-AzureRmADApplication.md) -Updates an existing azure active directory application. - -### [Update-AzureRmADServicePrincipal](Update-AzureRmADServicePrincipal.md) -Updates an existing azure active directory service principal. - -### [Update-AzureRmADUser](Update-AzureRmADUser.md) -Updates an existing active directory user. - -### [Update-AzureRmManagementGroup](Update-AzureRmManagementGroup.md) -Updates a Management Group - diff --git a/azurermps-2.5.0/AzureRm.Resources/Export-AzureRmResourceGroup.md b/azurermps-2.5.0/AzureRm.Resources/Export-AzureRmResourceGroup.md deleted file mode 100644 index 1f0fbde5fa..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Export-AzureRmResourceGroup.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 63BBDF98-75FC-4A44-9FD0-95AD21ED93A6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/export-azurermresourcegroup -schema: 2.0.0 ---- - -# Export-AzureRmResourceGroup - -## SYNOPSIS -Captures a resource group as a template and saves it to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Export-AzureRmResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue] - [-IncludeComments] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Export-AzureRmResourceGroup** cmdlet captures the specified resource group as a template and saves it to a JSON file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments. -This cmdlet gives you an easy start by generating the template for your existing resources in the resource group. -There might be some cases where this cmdlet fails to generate some parts of the template. -Warning messages will inform you of the resources that failed. -The template will still be generated for the parts that were successful. - -## EXAMPLES - -### Example 1: Export a resource group -``` -PS C:\>Export-AzureRmResourceGroup -ResourceGroupName "TestGroup" -``` - -This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If not specified, the latest API version is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeComments -Indicates that this operation exports the template with comments. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeParameterDefaultValue -Indicates that this operation exports the template parameter with the default value. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the output path of the template file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to export. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADAppCredential.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADAppCredential.md deleted file mode 100644 index 0422e13691..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADAppCredential.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6AC9DA05-756D-4D59-BD97-DBAAFBB3C7AC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadappcredential -schema: 2.0.0 ---- - -# Get-AzureRmADAppCredential - -## SYNOPSIS -Retrieves a list of credentials associated with an application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdParameterSet (Default) -``` -Get-AzureRmADAppCredential -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADAppCredential -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADAppCredential -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Get-AzureRmADAppCredential -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmADAppCredential cmdlet can be used to retrieve a list of credentials associated with an application. -This command will retrieve all of the credential properties (but not the credential value) associated with the application. - -## EXAMPLES - -### Example 1 - Get application credentials by object id - -``` -PS C:\> Get-AzureRmADAppCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 -``` - -Returns a list of credentials associated with the application having object id '1f99cf81-0146-4f4e-beae-2007d0668476'. - -### Example 2 - Get application credentials by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 | Get-AzureRmADAppCredential -``` - -Gets the application with object id '1f99cf81-0146-4f4e-beae-2007d0668476' and pipes it to the Get-AzureRmADAppCredential cmdlet to list all of the credentials for that application. - -## PARAMETERS - -### -ApplicationId -The id of the application to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to retrieve credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdParameterSet -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADApplication.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADApplication.md deleted file mode 100644 index 17ecfc0f6f..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADApplication.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 66AC5120-80B1-46F2-AA51-132BF361602E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadapplication -schema: 2.0.0 ---- - -# Get-AzureRmADApplication - -## SYNOPSIS -Lists existing azure active directory applications. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADApplication [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] - [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationObjectIdParameterSet -``` -Get-AzureRmADApplication -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADApplication -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADApplication -DisplayNameStartWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADApplication -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdentifierUriParameterSet -``` -Get-AzureRmADApplication -IdentifierUri <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Lists existing azure active directory applications. -Application lookup can be done by ObjectId, ApplicationId, IdentifierUri or DisplayName. -If no parameter is provided, it fetches all applications under the tenant. - -## EXAMPLES - -### Example 1 - List all applications - -``` -PS C:\> Get-AzureRmADApplication -``` - -Lists all the applications under a tenant. - -### Example 2 - List applications using paging - -``` -PS C:\> Get-AzureRmADApplication -First 100 -``` - -Lists the first 100 applications under a tenant. - -### Example 3 - Get application by identifier URI - -``` -PS C:\> Get-AzureRmADApplication -IdentifierUri http://mySecretApp1 -``` - -Gets the application with identifier uri as "http://mySecretApp1". - -### Example 4 - Get application by object id - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 39e64ec6-569b-4030-8e1c-c3c519a05d69 -``` - -Gets the application with the object id '39e64ec6-569b-4030-8e1c-c3c519a05d69'. - -## PARAMETERS - -### -ApplicationId -The application id of the application to fetch. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayNameStartWith -Fetch all applications starting with the display name. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierUri -Unique identifier Uri of the application to fetch. - -```yaml -Type: System.String -Parameter Sets: ApplicationIdentifierUriParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to fetch. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES - -## RELATED LINKS - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - - - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroup.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroup.md deleted file mode 100644 index 8d539356f2..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroup.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 85DDA491-7A7D-4217-B0E3-72CDC3787889 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadgroup -schema: 2.0.0 ---- - -# Get-AzureRmADGroup - -## SYNOPSIS -Filters active directory groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADGroup [-ObjectId <Guid>] [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADGroup -DisplayNameStartsWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADGroup -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADGroup -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory groups. - -## EXAMPLES - -### Example 1 - List all AD groups -``` -PS C:\> Get-AzureRmADGroup -``` - -Lists all AD groups in a tenant. - -### Example 2 - List all AD groups using paging - -``` -PS C:\> Get-AzureRmADGroup -First 100 -``` - -Lists the first 100 AD groups in a tenant. - -### Example 3 - Get AD group by object id - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -``` - -Gets an AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'. - -### Example 4 - List groups by search string - -``` -PS C:\> Get-AzureRmADGroup -SearchString Joe -``` - -Lists all AD groups whose display name begins with 'Joe'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the group. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayNameStartsWith -Used to find groups that begin with the provided string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the group. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - -[Get-AzureRmADGroupMember](./Get-AzureRmADGroupMember.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroupMember.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroupMember.md deleted file mode 100644 index 6f056631bb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADGroupMember.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 52C5CD8B-2489-4FE6-9F33-B3350531CD8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadgroupmember -schema: 2.0.0 ---- - -# Get-AzureRmADGroupMember - -## SYNOPSIS -Lists members of an AD group in the current tenant. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Get-AzureRmADGroupMember [-GroupObjectId <Guid>] [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADGroupMember -GroupDisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### GroupObjectParameterSet -``` -Get-AzureRmADGroupMember -GroupObject <PSADGroup> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Lists members of an AD group in the current tenant. - -## EXAMPLES - -### Example 1 - List members by AD group object id - -``` -PS C:\> Get-AzureRmADGroupMember -GroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -``` - -Lists members of the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'. - -### Example 2 - List members by AD group object id using paging - -``` -PS C:\> Get-AzureRmADGroupMember -GroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -First 100 -``` - -Lists the first 100 members of the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'. - -### Example 3 - List members by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE | Get-AzureRmADGroupMember -``` - -Gets the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' and pipes it to the Get-AzureRmADGroupMember cmdlet to list all members in that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupDisplayName -The display name of the group. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupObject -The group object that you are listing members from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: GroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupObjectId -Object Id of the group. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: Id, ObjectId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: GroupObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADObject - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADServicePrincipal.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADServicePrincipal.md deleted file mode 100644 index 7cf75fc1ef..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 4DC26C26-6162-4A15-BFCB-4D2B6B52DD81 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadserviceprincipal -schema: 2.0.0 ---- - -# Get-AzureRmADServicePrincipal - -## SYNOPSIS -Filters active directory service principals. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADServicePrincipal [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] [-Skip <UInt64>] - [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADServicePrincipal -DisplayNameBeginsWith <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADServicePrincipal -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADServicePrincipal -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Get-AzureRmADServicePrincipal -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Get-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmADServicePrincipal -ServicePrincipalName <String> [-DefaultProfile <IAzureContextContainer>] - [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory service principals. - -## EXAMPLES - -### Example 1 - List AD service principals - -``` -PS C:\> Get-AzureRmADServicePrincipal -``` - -Lists all AD service principals in a tenant. - -### Example 2 - List AD service principals using paging - -``` -PS C:\> Get-AzureRmADServicePrincipal -First 100 -``` - -Lists the first 100 AD service principals in a tenant. - -### Example 3 - List service principals by SPN - -``` -PS C:\> Get-AzureRmADServicePrincipal -ServicePrincipalName 36f81fc3-b00f-48cd-8218-3879f51ff39f -``` - -Lists service principals with the SPN '36f81fc3-b00f-48cd-8218-3879f51ff39f'. - -### Example 4 - List service principals by search string - -``` -PS C:\> Get-AzureRmADServicePrincipal -SearchString "Web" -``` - -Lists all AD service principals whose display name start with "Web". - -### Example 5 - List service principals by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 39e64ec6-569b-4030-8e1c-c3c519a05d69 | Get-AzureRmADServicePrincipal -``` - -Gets the AD application with object id '39e64ec6-569b-4030-8e1c-c3c519a05d69' and pipes it to the Get-AzureRmADServicePrincipal cmdlet to list all service principals for that application. - -## PARAMETERS - -### -ApplicationId -The service principal application id. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object whose service principal is being retrieved. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The service principal display name. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayNameBeginsWith -The service principal search string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the service principal. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -SPN of the service. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES - -## RELATED LINKS - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - - - -[Remove-AzureRmADServicePrincipal](./Remove-AzureRmADServicePrincipal.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADSpCredential.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADSpCredential.md deleted file mode 100644 index 179bbf00be..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADSpCredential.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 7690143F-5F09-4739-9F66-B2ACDF8305F4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermadspcredential -schema: 2.0.0 ---- - -# Get-AzureRmADSpCredential - -## SYNOPSIS -Retrieves a list of credentials associated with a service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Get-AzureRmADSpCredential -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmADSpCredential -ServicePrincipalName <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADSpCredential -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNObjectParameterSet -``` -Get-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmADSpCredential cmdlet can be used to retrieve a list of credentials associated with a service principal. -This command will retrieve all of the credential properties (but not the credential value) associated with the service principal. - -## EXAMPLES - -### Example 1 - List credentials by SPN - -``` -PS C:\> Get-AzureRmADSpCredential -ServicePrincipalName http://test12345 -``` - -Returns a list of credentials associated with the service principal with SPN 'http://test12345'. - -### Example 2 - List credentials by object id - -``` -PS C:\> Get-AzureRmADSpCredential -ObjectId 58e28616-99cc-4da4-b705-7672130e1047 -``` - -Returns a list of credentials associated with the service principal with object id "58e28616-99cc-4da4-b705-7672130e1047". - -### Example 3 - List credentials by piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 58e28616-99cc-4da4-b705-7672130e1047 | Get-AzureRmADSpCredential -``` - -Gets the service principal with object id "58e28616-99cc-4da4-b705-7672130e1047" and pipes it to the Get-AzureRmADSpCredential cmdlet to list all credentials for that service principal. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to retrieve credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to retrieve credentials from. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to retrieve the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: SPNObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADUser.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADUser.md deleted file mode 100644 index ed54ef442b..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmADUser.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: BF254F2F-F658-45CC-8AC8-53FF96CFCAAD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermaduser -schema: 2.0.0 ---- - -# Get-AzureRmADUser - -## SYNOPSIS -Filters active directory users. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmADUser [-UserPrincipalName <String>] [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### SearchStringParameterSet -``` -Get-AzureRmADUser -StartsWith <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Get-AzureRmADUser -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmADUser -ObjectId <Guid> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Get-AzureRmADUser -UserPrincipalName <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -### MailParameterSet -``` -Get-AzureRmADUser -Mail <String> [-DefaultProfile <IAzureContextContainer>] [-IncludeTotalCount] - [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>] -``` - -## DESCRIPTION -Filters active directory users. - -## EXAMPLES - -### Example 1 - List all users - -``` -PS C:\> Get-AzureRmADUser -``` - -Lists all AD users in a tenant. - -### Example 2 - List all users using paging - -``` -PS C:\> Get-AzureRmADUser -First 100 -``` - -Lists the first 100 AD users in a tenant. - -### Example 3 - Get AD user by user principal name - -``` -PS C:\> Get-AzureRmADUser -UserPrincipalName foo@domain.com -``` - -Gets the AD user with user principal name "foo@domain.com". - -### Example 4 - List by search string - -``` -PS C:\> Get-AzureRmADUser -SearchString Joe -``` - -Lists all AD users whose display name starts with "Joe". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the user. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -The maximum number of objects to return. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeTotalCount -Reports the number of objects in the data set. Currently, this parameter does nothing. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mail -The user mail. - -```yaml -Type: System.String -Parameter Sets: MailParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -Object id of the user. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Skip -Ignores the first N objects and then gets the remaining objects. - -```yaml -Type: System.UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartsWith -Used to find users that begin with the provided string. - -```yaml -Type: System.String -Parameter Sets: SearchStringParameterSet -Aliases: SearchString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -UPN of the user. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet -Aliases: UPN - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS - -[New-AzureRmADUser](./New-AzureRmADUser.md) - - - -[Remove-AzureRmADUser](./Remove-AzureRmADUser.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeployment.md deleted file mode 100644 index 11002c50aa..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeployment.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermdeployment -schema: 2.0.0 ---- - -# Get-AzureRmDeployment - -## SYNOPSIS -Get deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByDeploymentName (Default) -``` -Get-AzureRmDeployment [[-Name] <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByDeploymentId -``` -Get-AzureRmDeployment [-Id <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDeployment** cmdlet gets the deployments at the current subscription scope. -Specify the *Name* or *Id* parameter to filter the results. -By default, **Get-AzureRmDeployment** gets all deployments at the current subscription scope. - -## EXAMPLES - -### Example 1: Get all deployments at subscription scope -``` -PS C:\>Get-AzureRmDeployment -``` - -This command gets all deployments at the current subscription scope. - -### Example 2: Get a deployment by name -``` -PS C:\>Get-AzureRmDeployment -Name "DeployRoles01" -``` - -This command gets the DeployRoles01 deployment at the current subscription scope. -You can assign a name to a deployment when you create it by using the **New-AzureRmDeployment** cmdlets. -If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: 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 resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: GetByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of deployment. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: DeploymentName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeploymentOperation.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeploymentOperation.md deleted file mode 100644 index f8cdf14ae3..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmDeploymentOperation.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermdeploymentoperation -schema: 2.0.0 ---- - -# Get-AzureRmDeploymentOperation - -## SYNOPSIS -Get deployment operation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByDeploymentName (Default) -``` -Get-AzureRmDeploymentOperation -DeploymentName <String> [-OperationId <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByDeploymentObject -``` -Get-AzureRmDeploymentOperation -DeploymentObject <PSDeployment> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. -It can also show the response and the request content for each deployment operation. -This is the same information provided in the deployment details on the portal. - -To get the request and the response content, enable the setting when submitting a deployment through **New-AzureRmDeployment**. -It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. -For more on this setting and how to enable it, see New-AzureRmDeployment and Debugging ARM template deployments - -## EXAMPLES - -### Get deployment operations given a deployment name -``` -PS C:\>Get-AzureRmDeploymentOperation -DeploymentName test -``` - -Gets deployment operation with name "test" at the current subscription scope. - -### Get a deployment and get its deployment operations -``` -PS C:\>Get-AzureRmDeployment -Name "test" | Get-AzureRmDeploymentOperation -``` - -This command gets the deployment "test" at the current subscription scope and get its deployment operations. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: GetByDeploymentObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OperationId -The deployment operation Id. - -```yaml -Type: String -Parameter Sets: GetByDeploymentName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentOperation - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmLocation.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmLocation.md deleted file mode 100644 index 26518c27e3..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmLocation.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: DC870E11-2129-4906-8357-D9BC1CF2E08E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermlocation -schema: 2.0.0 ---- - -# Get-AzureRmLocation - -## SYNOPSIS -Gets all locations and the supported resource providers for each location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmLocation [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmLocation** cmdlet gets all locations and the supported resource providers for each location. - -## EXAMPLES - -### Example 1: Get all locations and the supported resource providers -``` -PS C:\>Get-AzureRmLocation -``` - -This command gets all locations and the supported resource providers for each location. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplication.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplication.md deleted file mode 100644 index 356ff12be9..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplication.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermmanagedapplication -schema: 2.0.0 ---- - -# Get-AzureRmManagedApplication - -## SYNOPSIS -Gets managed applications - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetBySubscription (Default) -``` -Get-AzureRmManagedApplication [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### GetByNameAndResourceGroup -``` -Get-AzureRmManagedApplication [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetById -``` -Get-AzureRmManagedApplication -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmManagedApplication** cmdlet gets managed applications - -## EXAMPLES - -### Example 1: Get all managed applications under a resource group -``` -PS C:\>Get-AzureRmManagedApplication -ResourceGroupName "MyRG" -``` - -This command gets managed applications under resource group "MyRG" - -### Example 2: Get all managed applications -``` -PS C:\>Get-AzureRmManagedApplication -``` - -This command get all managed applications under the current subscription - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 managed application Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: String -Parameter Sets: GetById -Aliases: ResourceId, ManagedApplicationId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplicationDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index 1ebfb4161a..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermmanagedapplicationdefinition -schema: 2.0.0 ---- - -# Get-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Gets managed application definitions - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByNameAndResourceGroup (Default) -``` -Get-AzureRmManagedApplicationDefinition [-Name <String>] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetById -``` -Get-AzureRmManagedApplicationDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmManagedApplicationDefinition** cmdlet gets managed application definitions - -## EXAMPLES - -### Example 1: Get all managed application definitions under a resource group -``` -PS C:\>Get-AzureRmManagedApplicationDefinition -ResourceGroupName "MyRG" -``` - -This command gets the managed application definitions under resource group "MyRG" - -### Example 2: Get a managed application definition -``` -PS C:\>Get-AzureRmManagedApplicationDefinition -ResourceGroupName "MyRG" -Name "myManagedAppDef" -``` - -This command gets the managed application definition "myManagedAppDef" under resource group "MyRG" - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 managed application definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: String -Parameter Sets: GetById -Aliases: ResourceId, ManagedApplicationDefinitionId - -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: GetByNameAndResourceGroup -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: GetByNameAndResourceGroup -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAlias.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAlias.md deleted file mode 100644 index a62e1ec041..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAlias.md +++ /dev/null @@ -1,385 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRm.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicyalias -schema: 2.0.0 ---- - -# Get-AzureRmPolicyAlias - -## SYNOPSIS -Get-AzureRmPolicyAlias retrieves and outputs Azure provider resource types that have aliases defined and match the -given parameter values. If no parameters are provided, all provider resource types that contain an alias will be output. -The -ListAvailable switch modifies this behavior by listing all matching resource types including those without aliases. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmPolicyAlias [-NamespaceMatch <String>] [-ResourceTypeMatch <String>] [-AliasMatch <String>] - [-PathMatch <String>] [-ApiVersionMatch <String>] [-LocationMatch <String>] [-ListAvailable] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyAlias** cmdlet gets a listing of policy aliases. -Policy aliases are used by Azure Policy to refer to resource type properties. -Parameters are provided that limit items in the listing by matching various properties of the resource type or its aliases. -A given match value matches if the target string contains it using case insensitive comparison. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-AzureRmPolicyAlias - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/state, Microsoft.AnalysisServices/s... -Microsoft.Authorization roleAssignments {Microsoft.Authorization/roleAssignments/roleDefinitionId, Microsoft.Au... -Microsoft.Authorization roleDefinitions {Microsoft.Authorization/roleDefinitions/type, Microsoft.Authorization/... - -... ... ... - -Microsoft.Web hostingEnvironments {Microsoft.Web/hostingEnvironments/clusterSettings[*].name, Microsoft.W... -Microsoft.Web sites/config {Microsoft.Web/sites/config/httpLoggingEnabled, Microsoft.Web/sites/con... -Microsoft.GuestConfiguration guestConfigurationAssignments {Microsoft.GuestConfiguration/guestConfigurationAssignments/complianceS... - - -PS C:\> -``` - -Lists all provider resource types that have an alias. - -### Example 2 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ListAvailable - -Namespace ResourceType Aliases ---------- ------------ ------- - -... ... ... - -Microsoft.AlertsManagement operations {} -Microsoft.AnalysisServices servers {Microsoft.AnalysisServices/servers/sta... -Microsoft.AnalysisServices locations {} - -... ... ... - - -PS C:\> -``` - -Lists all provider resource types, including those without aliases. - -### Example 3 -```powershell -PS C:\> Get-AzureRmPolicyAlias -NamespaceMatch 'compute' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... -Microsoft.Compute disks {Microsoft.Compute/imagePublisher, Microsoft.Compute/imageOffer, Microsoft.Compute/imageSku, Mi... - - -PS C:\> -``` - -Lists all provider resource types whose namespace matches 'compute' and contain an alias. - -### Example 4 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ResourceTypeMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Micro... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualM... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleS... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGateway... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetworks... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers/vi... - - -PS C:\> -``` - -Lists all provider resource types whose resource type matches 'virtual' and contain an alias. - -### Example 5 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ResourceTypeMatch 'virtual' -ListAvailable - -Namespace ResourceType Aliases ---------- ------------ ------- - -... ... ... - -Microsoft.KeyVault locations/deleteVirtualNetworkOrSubnets {} -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id,... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsof... -Microsoft.Network locations/virtualNetworkAvailableEndpointServices {} - -... ... ... - - -PS C:\> -``` - -Lists all provider resource types whose resource type matches 'virtual', including those without aliases. - -### Example 6 -```powershell -PS C:\> Get-AzureRmPolicyAlias -NamespaceMatch 'compute' -ResourceTypeMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Microsoft... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtualMachi... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineScaleSets/... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compute/virt... - - -PS C:\> -``` - -Lists all provider resource types whose namespace matches 'compute' and resource type matches 'virtual' and contain an alias. -Note: -NamespaceMatch and -ResourceTypeMatch provide exclusive matches, whereas the others are inclusive. - -### Example 7 -```powershell -PS C:\> Get-AzureRmPolicyAlias -AliasMatch 'virtual' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... -Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... -Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... -Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... -Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... - - -PS C:\> -``` - -Lists all provider resource types that contain an alias matching 'virtual'. - -### Example 8 -```powershell -PS C:\> Get-AzureRmPolicyAlias -AliasMatch 'virtual' -PathMatch 'network' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Compute virtualMachines {Microsoft.Compute/licenseType, Microsoft.Compute/virtualMachines/availabilitySet.id, Mi... -Microsoft.Compute virtualMachines/extensions {Microsoft.Compute/virtualMachines/extensions/provisioningState, Microsoft.Compute/virtu... -Microsoft.Compute virtualMachineScaleSets {Microsoft.Compute/VirtualMachineScaleSets/sku.name, Microsoft.Compute/VirtualMachineSca... -Microsoft.Compute virtualMachineScaleSets/extensions {Microsoft.Compute/virtualMachineScaleSets/extensions/provisioningState, Microsoft.Compu... -Microsoft.DocumentDB databaseAccounts {Microsoft.DocumentDB/databaseAccounts/sku.name, Microsoft.DocumentDB/databaseAccounts/v... -Microsoft.HDInsight clusters {Microsoft.HDInsight/clusters/clusterVersion, Microsoft.HDInsight/clusters/osType, Micro... -Microsoft.KeyVault vaults {Microsoft.KeyVault/vaults/sku.name, Microsoft.KeyVault/vaults/sku.family, Microsoft.Key... -Microsoft.Network virtualNetworks {Microsoft.Network/virtualNetworks/subnets[*].routeTable.id, Microsoft.Network/virtualNe... -Microsoft.Network networkInterfaces {Microsoft.Network/networkInterfaces/ipconfigurations[*].subnet.id, Microsoft.Network/ne... -Microsoft.Network networkSecurityGroups {Microsoft.Network/networkSecurityGroups/securityRules[*].protocol, Microsoft.Network/ne... -Microsoft.Network virtualNetworkGateways {Microsoft.Network/virtualNetworkGateways/sku.name, Microsoft.Network/virtualNetworkGate... -Microsoft.Network virtualNetworks/subnets {Microsoft.Network/virtualNetworks/subnets/routeTable.id, Microsoft.Network/virtualNetwo... -Microsoft.Network virtualNetworks/virtualNetworkPeerings {Microsoft.Network/virtualNetworks/virtualNetworkPeerings/remoteVirtualNetwork.id} -Microsoft.Sql servers/virtualNetworkRules {Microsoft.Sql/servers/virtualNetworkRules/virtualNetworkSubnetId, Microsoft.Sql/servers... -Microsoft.Storage storageAccounts {Microsoft.Storage/storageAccounts/accountType, Microsoft.Storage/storageAccounts/sku.na... - - -PS C:\> -``` - -Lists all provider resource types that contain an alias matching 'virtual' or an alias with a path matching 'network'. - -### Example 9 -```powershell -PS C:\> Get-AzureRmPolicyAlias -ApiVersionMatch 'alpha' - -Namespace ResourceType Aliases ---------- ------------ ------- -Microsoft.Cache Redis {Microsoft.Cache/Redis/sku.name, Microsoft.Cache/Redis/sku.family, Microsoft.Cache/Redis/sku.capacity, Micros... -Microsoft.Cache Redis/firewallrules {Microsoft.Cache/Redis/firewallrules/startIP, Microsoft.Cache/Redis/firewallrules/endIP} -Microsoft.Security alerts {Microsoft.Security/alerts/state} -Microsoft.Security pricings {Microsoft.Security/pricings/pricingTier} -Microsoft.Security complianceResults {Microsoft.Security/complianceResults/resourceStatus} - - -PS C:\> -``` - -Lists all provider resource types with alpha api version or containing an alias with an alpha api version. - -## PARAMETERS - -### -AliasMatch -Includes in the output items with aliases whose name matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Alias - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersion -When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersionMatch -Includes in the output items whose resource types or aliases have a matching api version. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -Includes in the output matching items with and without aliases. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ShowAll - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationMatch -Includes in the output items whose resource types have a matching location. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Location - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NamespaceMatch -Limits the output to items whose namespace matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Name, Namespace - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PathMatch -Includes in the output items with aliases containing a path that matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: Path - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceTypeMatch -Limits the output to items whose resource type matches this value. -```yaml -Type: String -Parameter Sets: (All) -Aliases: ResourceType, Resource - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.PsResourceProviderAlias - -## NOTES - -* To expand the Aliases or any other property, pipe the output to `select -ExpandProperty <property>`. For example: `Get-AzureRmPolicyAlias -NamespaceMatch 'Microsoft.Cache' -ApiVersionMatch 'alpha' | select -ExpandProperty Aliases | select -Property Name -ExpandProperty Paths` - -* Additional properties are available in the output and can be displayed by piping the output to `Format-List`. For example: `Get-AzureRmPolicyAlias -NamespaceMatch 'Web' -ResourceTypeMatch site -PathMatch cert | Format-List` - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAssignment.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAssignment.md deleted file mode 100644 index 7759c857d6..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2DBAF415-A039-479E-B3CA-E00FD5E476C9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicyassignment -schema: 2.0.0 ---- - -# Get-AzureRmPolicyAssignment - -## SYNOPSIS -Gets policy assignments. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Get-AzureRmPolicyAssignment [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### NameParameterSet -``` -Get-AzureRmPolicyAssignment [-Name <String>] [-Scope <String>] [-PolicyDefinitionId <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IncludeDescendentParameterSet -``` -Get-AzureRmPolicyAssignment [-Scope <String>] [-IncludeDescendent] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicyAssignment -Id <String> [-PolicyDefinitionId <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyAssignment** cmdlet gets all policy assignments or particular assignments. -Identify a policy assignment to get by name and scope or by ID. - -## EXAMPLES - -### Example 1: Get all policy assignments -``` -PS C:\> Get-AzureRmPolicyAssignment -``` - -This command gets all the policy assignments. - -### Example 2: Get a specific policy assignment -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> Get-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdletand stores it in the $ResourceGroup variable. -The second command gets the policy assignment named PolicyAssignment07 for the scope that the **ResourceId** property of $ResourceGroup identifies. - -### Example 3: Get all policy assignments assigned to a management group -``` -PS C:\> $mgId = 'myManagementGroup' -PS C:\> Get-AzureRmPolicyAssignment -Scope '/providers/Microsoft.Management/managementgroups/$mgId' -``` - -The first command specifies the ID of the management group to query. -The second command gets all of the policy assignments that are assigned to the management group with ID 'myManagementGroup'. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeDescendent -Causes the list of returned policy assignments to include all assignments related to the given scope, including those from ancestor scopes and those from descendent scopes. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: IncludeDescendentParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy assignment that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinitionId -Specifies the ID of the policy definition of the policy assignments that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, IdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied for the assignment that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, IncludeDescendentParameterSet -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyDefinition.md deleted file mode 100644 index 05e60e4ac2..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6396AEC3-DFE6-45DA-BCF4-69C55C5D051B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicydefinition -schema: 2.0.0 ---- - -# Get-AzureRmPolicyDefinition - -## SYNOPSIS -Gets policy definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Get-AzureRmPolicyDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Get-AzureRmPolicyDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Get-AzureRmPolicyDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicyDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BuiltinFilterParameterSet -``` -Get-AzureRmPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### CustomFilterParameterSet -``` -Get-AzureRmPolicyDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicyDefinition** cmdlet gets a collection of policy definitions or a specific policy definition identified by name or ID. - -## EXAMPLES - -### Example 1: Get all policy definitions -``` -PS C:\> Get-AzureRmPolicyDefinition -``` - -This command gets all the policy definitions. - -### Example 2: Get policy definition from current subscription by name -``` -PS C:\> Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -``` - -This command gets the policy definition named VMPolicyDefinition from the current default subscription. - -### Example 3: Get policy definition from management group by name -``` -PS C:\> Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42' -``` - -This command gets the policy definition named VMPolicyDefinition from the management group named Dept42. - -### Example 4: Get all built-in policy definitions from subscription -``` -PS C:\> Get-AzureRmPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin -``` - -This command gets all built-in policy definitions from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Builtin -Limits list of results to only built-in policy definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BuiltinFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -Limits list of results to only custom policy definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CustomFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition(s) to get. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -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 gets. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition(s) to get. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicySetDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicySetDefinition.md deleted file mode 100644 index 25680d0ee1..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermpolicysetdefinition -schema: 2.0.0 ---- - -# Get-AzureRmPolicySetDefinition - -## SYNOPSIS -Gets policy set definitions. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Get-AzureRmPolicySetDefinition [-Name <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Get-AzureRmPolicySetDefinition [-Name <String>] -ManagementGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Get-AzureRmPolicySetDefinition [-Name <String>] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Get-AzureRmPolicySetDefinition -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### BuiltinFilterParameterSet -``` -Get-AzureRmPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Builtin] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### CustomFilterParameterSet -``` -Get-AzureRmPolicySetDefinition [-ManagementGroupName <String>] [-SubscriptionId <Guid>] [-Custom] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmPolicySetDefinition** cmdlet gets a collection of policy set definitions or a specific policy set definition identified by name or ID. - -## EXAMPLES - -### Example 1: Get all policy set definitions -``` -PS C:\> Get-AzureRmPolicySetDefinition -``` - -This command gets all the policy set definitions. - -### Example 2: Get policy set definition from current subscription by name -``` -PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition' -``` - -This command gets the policy set definition named VMPolicySetDefinition from the current default subscription. - -### Example 3: Get policy set definition from subscription by name -``` -PS C:\> Get-AzureRmPolicySetDefinition -Name 'VMPolicySetDefinition' -subscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -``` - -This command gets the policy definition named VMPolicySetDefinition from the subscription with ID 3bf44b72-c631-427a-b8c8-53e2595398ca. - -### Example 4: Get all custom policy set definitions from management group -``` -PS C:\> Get-AzureRmPolicySetDefinition -ManagementGroupName 'Dept42' -Custom -``` - -This command gets all custom policy set definitions from the management group named Dept42. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Builtin -Limits list of results to only built-in policy set definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: BuiltinFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -Limits list of results to only custom policy set definitions. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: CustomFilterParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition(s) to get. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition(s) to get. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: BuiltinFilterParameterSet, CustomFilterParameterSet -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderFeature.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderFeature.md deleted file mode 100644 index 8ebf5607d6..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderFeature.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2970E81E-A788-4829-B1FF-B522A91DE4B1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermproviderfeature -schema: 2.0.0 ---- - -# Get-AzureRmProviderFeature - -## SYNOPSIS -Gets information about Azure provider features. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAvailableParameterSet (Default) -``` -Get-AzureRmProviderFeature [-ProviderNamespace <String>] [-ListAvailable] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetFeature -``` -Get-AzureRmProviderFeature -ProviderNamespace <String> -FeatureName <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmProviderFeature** cmdlet gets the feature name, provider name, and registration status for Azure provider features. - -## EXAMPLES - -### Example 1: Get all available features -``` -PS C:\>Get-AzureRmProviderFeature -ListAvailable -``` - -This command gets all available features. - -### Example 2: Get information about a specific feature -``` -PS C:\>Get-AzureRmProviderFeature -FeatureName "AllowPreReleaseRegions" -ProviderNamespace "Microsoft.Compute" -``` - -This command gets information for the feature named AllowPreReleaseRegions for the specified provider. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: GetFeature -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListAvailable -Indicates that this cmdlet gets all features. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListAvailableParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace for which this cmdlet gets provider features. - -```yaml -Type: System.String -Parameter Sets: ListAvailableParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: GetFeature -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Register-AzureRmProviderFeature](./Register-AzureRmProviderFeature.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderOperation.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderOperation.md deleted file mode 100644 index 4da50f29fd..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmProviderOperation.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6424B740-DBFB-490C-AEAA-EDD60952B435 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermprovideroperation -schema: 2.0.0 ---- - -# Get-AzureRmProviderOperation - -## SYNOPSIS -Gets the operations for an Azure resource provider that are securable using Azure RBAC. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmProviderOperation [[-OperationSearchString] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Get-AzureRmProviderOperation gets the operations exposed by Azure resource providers. -Operations can be composed to create custom roles in Azure RBAC. -The command takes as input an operation search string (with possible wildcard(*) character(s)) which determines the operations details to display. -Use Get-AzureRmProviderOperation * to get all operations for all Azure resource providers. -Use Get-AzureRmProviderOperation Microsoft.Compute/* to get all operations of Microsoft.Compute resource provider. - -## EXAMPLES - -### Get all actions for all providers -``` -PS C:\> Get-AzureRmProviderOperation * -``` - -### Get actions for a particular resource provider -``` -PS C:\> Get-AzureRmProviderOperation Microsoft.Insights/* -``` - -### Get all actions that can be performed on virtual machines -``` -PS C:\> Get-AzureRmProviderOperation */virtualMachines/* -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: False -Position: 0 -Default value: "*" -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: OperationSearchString (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.PSResourceProviderOperation - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResource.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResource.md deleted file mode 100644 index 67991a9ed1..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResource.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C2C608E5-3351-4D01-8533-9668B2E9F1D1 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresource -schema: 2.0.0 ---- - -# Get-AzureRmResource - -## SYNOPSIS - -Gets resources. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTagNameValueParameterSet (Default) -``` -Get-AzureRmResource [[-Name] <String>] [-ResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-TagName <String>] [-TagValue <String>] [-ExpandProperties] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByResourceId -``` -Get-AzureRmResource -ResourceId <String> [-ExpandProperties] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTagObjectParameterSet -``` -Get-AzureRmResource [[-Name] <String>] [-ResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] -Tag <Hashtable> [-ExpandProperties] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION - -The **Get-AzureRmResource** cmdlet gets Azure resources. - -## EXAMPLES - -### Example 1: Get all resources in the current subscription - -``` -PS C:\> Get-AzureRmResource | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -disk testRG Microsoft.Compute/disks westus -nic testRG Microsoft.Network/networkInterfaces westus -nsg testRG Microsoft.Network/networkSecurityGroups westus -ip testRG Microsoft.Network/publicIPAddresses westus -vnet testRG Microsoft.Network/virtualNetworks westus -testKV otherRG Microsoft.KeyVault/vaults eastus -storage otherResourceGroup Microsoft.Storage/storageAccounts eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources in the current subscription. - -### Example 2: Get all resources in a resource group - -``` -PS C:\> Get-AzureRmResource -ResourceGroupName testRG | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -disk testRG Microsoft.Compute/disks westus -nic testRG Microsoft.Network/networkInterfaces westus -nsg testRG Microsoft.Network/networkSecurityGroups westus -ip testRG Microsoft.Network/publicIPAddresses westus -vnet testRG Microsoft.Network/virtualNetworks westus -``` - -This command gets all of the resources in the resource group "testRG". - -### Example 3: Get all resources whose resource group matches the provided wildcard - -``` -PS C:\> Get-AzureRmResource -ResourceGroupName other* | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testKV otherRG Microsoft.KeyVault/vaults eastus -storage otherResourceGroup Microsoft.Storage/storageAccounts eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources whose resource group they belong in beings with "other". - -### Example 4: Get all resources with a given name - -``` -PS C:\> Get-AzureRmResource -Name testVM | fl - -Name : testVM -ResourceGroupName : testRG -ResourceType : Microsoft.Compute/virtualMachines -Location : westus -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM -``` - -This command gets all of the resources whose resource name is "testVM". - -### Example 5: Get all resources whose name matches the provided wildcard - -``` -PS C:\> Get-AzureRmResource -Name test* | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -testKV otherRG Microsoft.KeyVault/vaults eastus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources whose resource name begins with "test". - -### Example 6: Get all resources of a given resource type - -``` -PS C:\> Get-AzureRmResource -ResourceType Microsoft.Compute/virtualMachines | ft - -Name ResourceGroupName ResourceType Location ----- ----------------- ------------ -------- -testVM testRG Microsoft.Compute/virtualMachines westus -testVM2 otherResourceGroup Microsoft.Compute/virtualMachines eastus -``` - -This command gets all of the resources in the current subscriptions that are virtual machines. - -### Example 7: Get a resource by resource id - -``` -PS C:\> Get-AzureRmResource -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM - -Name : testVM -ResourceGroupName : testRG -ResourceType : Microsoft.Compute/virtualMachines -Location : westus -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testVM -``` - -This command gets the resource with the provided resource id, which is a virtual machine called "testVM" in the resource group "testRG". - -## PARAMETERS - -### -ApiVersion - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExpandProperties -When specified, expands the properties of the resource. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the resource(s) to be retrieved. This parameter supports wildcards at the beginning and/or end of the string. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: ResourceName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group the resource(s) that is retireved belongs in. This parameter supports wildcards at the beginning and/or end of the string. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, as in the following example -`/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Compute/virtualMachines` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type of the resource(s) to be retrieved. For example, Microsoft.Compute/virtualMachines - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet, ByTagObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag - -Gets resources that have the specified Azure tag. Enter a hash table with a Name key or Name and Value keys. Wildcard characters are not supported.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. To add a tag to a resource, use the Tag parameter of the New-AzureRmResource or Set-AzureRmResource cmdlets. To create a predefined tag, use the New-AzureRmTag cmdlet. For help with hash tables in Windows PowerShell, run 'Get-Help about_Hashtables'. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTagObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TagName -The key in the tag of the resource(s) to be retrieved. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TagValue -The value in the tag of the resource(s) to be retrieved. - -```yaml -Type: System.String -Parameter Sets: ByTagNameValueParameterSet -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResource - -## NOTES - -## RELATED LINKS - - - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroup.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroup.md deleted file mode 100644 index a3e1442c97..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroup.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 5B17A241-BF36-48A6-BC29-4C32C08F5F94 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroup -schema: 2.0.0 ---- - -# Get-AzureRmResourceGroup - -## SYNOPSIS -Gets resource groups. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroupName (Default) -``` -Get-AzureRmResourceGroup [-Name <String>] [-Location <String>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroupId -``` -Get-AzureRmResourceGroup [-Location <String>] [-Id <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroup** cmdlet gets Azure resource groups in the current subscription. -You can get all resource groups, or specify a resource group by name or by other properties. -By default, this cmdlet gets all resource groups in the current subscription. -For more information about Azure resources and Azure resource groups, see the New-AzureRmResourceGroup cmdlet. - -## EXAMPLES - -### Example 1: Get a resource group by name -``` -PS C:\>Get-AzureRmResourceGroup -Name "EngineerBlog" -``` - -This command gets the Azure resource group in your subscription named EngineerBlog. - -### Example 2: Get all tags of a resource group -``` -PS C:\>(Get-AzureRmResourceGroup -Name "ContosoRG").Tags -``` - -This command gets the resource group named ContosoRG, and displays the tags associated with that group. - -### Example 3: Show the Resource groups by location -``` -PS C:\> Get-AzureRmResourceGroup | - Sort Location,ResourceGroupName | - Format-Table -GroupBy Location ResourceGroupName,ProvisioningState,Tags -``` - -### Example 4: Show the names of all the Resource groups in a particular location -``` -PS C:\> Get-AzureRmResourceGroup -Location westus2 | - Sort ResourceGroupName | - Format-Wide ResourceGroupName -Column 4 -``` - -### Example 5: Show the Resource groups whose names begin with WebServer -``` -PS C:\> Get-AzureRmResourceGroup | Where ResourceGroupName -like WebServer* -``` - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource group to get. - -```yaml -Type: System.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 resource group to get. This parameter supports wildcards at the beginning and/or the end of the string. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupName -Aliases: ResourceGroupName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -The tag hashtable to filter resource groups by. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: GetByResourceGroupName -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 0af704b1eb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 20CB842B-F7A9-4052-85D9-0DF9586D5FEA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroupdeployment -schema: 2.0.0 ---- - -# Get-AzureRmResourceGroupDeployment - -## SYNOPSIS -Gets the deployments in a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### GetByResourceGroupDeploymentName (Default) -``` -Get-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [[-Name] <String>] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### GetByResourceGroupDeploymentId -``` -Get-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroupDeployment** cmdlet gets the deployments in an Azure resource group. -Specify the *Name* or *Id* parameter to filter the results. -By default, **Get-AzureRmResourceGroupDeployment** gets all deployments for a specified resource group. -An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. -An Azure resource group is a collection of Azure resources that are deployed as a unit. -A deployment is the operation that makes the resources in the resource group available for use. -For more information about Azure resources and Azure resource groups, see the New-AzureRmResourceGroup cmdlet. -You can use this cmdlet for tracking. -For debugging, use this cmdlet with the Get-AzureRmLog cmdlet. - -## EXAMPLES - -### Example 1: Get all deployments for a resource group -``` -PS C:\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -``` - -This command gets all deployments for the ContosoLabsRG resource group. -The output shows a deployment for a WordPress blog that used a gallery template. - -### Example 2: Get a deployment by name -``` -PS C:\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -Name "DeployWebsite01" -``` - -This command gets the DeployWebsite01 deployment of the ContosoLabsRG resource group. -You can assign a name to a deployment when you create it by using the **New-AzureRmResourceGroup** or **New-AzureRmResourceGroupDeployment** cmdlets. -If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment. - -### Example 3: Get the deployments of all resource groups -``` -PS C:\>Get-AzureRmResourceGroup | Get-AzureRmResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState -``` - -This command gets all resource groups in your subscription by using the Get-AzureRmResourceGroup cmdlet. -The command passes the resource groups to the current cmdlet by using the pipeline operator. -The current cmdlet gets all deployments of all resource groups in the subscription, and passes the results to the Format-Table cmdlet to display their **ResourceGroupName**, **DeploymentName**, and **ProvisioningState** property values. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the deployment to get. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentName -Aliases: DeploymentName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group. -The cmdlet gets the deployments for the resource group that this parameter specifies. -Wildcard characters are not permitted. -This parameter is required and you can specify only one resource group in each command. - -```yaml -Type: System.String -Parameter Sets: GetByResourceGroupDeploymentName -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models. PSResourceGroupDeployment - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeploymentOperation.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeploymentOperation.md deleted file mode 100644 index 412b5caac7..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceGroupDeploymentOperation.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 9F29DFCB-A02B-45A5-99B9-C054BF4FCA6C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcegroupdeploymentoperation -schema: 2.0.0 ---- - -# Get-AzureRmResourceGroupDeploymentOperation - -## SYNOPSIS -Gets the resource group deployment operation - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmResourceGroupDeploymentOperation -DeploymentName <String> [-SubscriptionId <Guid>] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceGroupDeploymentOperation** cmdlet lists all the operations that were part of a deployment to help you identify and give more information about the exact operations that failed for a particular deployment. -It can also show the response and the request content for each deployment operation. -This is the same information provided in the deployment details on the portal. -To get the request and the response content, enable the setting when submitting a deployment through **New-AzureRmResourceGroupDeployment**. -It can potentially log and expose secrets like passwords used in the resource property or **listKeys** operations that are then returned when you retrieve the deployment operations. -For more on this setting and how to enable it, see New-AzureRmResourceGroupDeployment and Debugging ARM template deployments - -## EXAMPLES - -### Get1 -``` -PS C:\>Get-AzureRmResourceGroupDeploymentOperation -DeploymentName test -ResourceGroupName test -``` - -Gets deployment operation with name "test" under resource group "test" - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription to use. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceLock.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceLock.md deleted file mode 100644 index b78ec2e411..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceLock.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 3FBF91B8-8EF9-4E05-AD7E-AEFC6EBBFB8E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourcelock -schema: 2.0.0 ---- - -# Get-AzureRmResourceLock - -## SYNOPSIS -Gets a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceGroup -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySpecifiedScope -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySubscription -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Get-AzureRmResourceLock [-LockName <String>] [-AtScope] -ResourceName <String> -ResourceType <String> - [-TenantLevel] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### ByLockId -``` -Get-AzureRmResourceLock [-AtScope] -LockId <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceLock** cmdlet gets Azure resource locks. - -## EXAMPLES - -### Example 1: Get a lock -``` -PS C:\>Get-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" -``` - -This command gets the resource lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AtScope -Indicates that this cmdlet returns all locks at or above the specified scope. -If you do not specify this parameter, the cmdlet returns all locks at, above, or below the scope. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet gets. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. -This cmdlet gets locks for this resource group. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which this lock applies. -This cmdlet gets locks for this resource. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which this lock applies. -This cmdlet gets locks for this resource. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -The cmdlet gets locks for this scope. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceProvider.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceProvider.md deleted file mode 100644 index d98d0dc5a4..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmResourceProvider.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6AB09621-488B-4A16-92D9-9C47EB87DA95 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermresourceprovider -schema: 2.0.0 ---- - -# Get-AzureRmResourceProvider - -## SYNOPSIS -Gets a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ListAvailable (Default) -``` -Get-AzureRmResourceProvider [-Location <String>] [-ListAvailable] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### IndividualProvider -``` -Get-AzureRmResourceProvider -ProviderNamespace <String[]> [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmResourceProvider** cmdlet gets an Azure resource provider. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ListAvailable -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String[] -Parameter Sets: IndividualProvider -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Register-AzureRmResourceProvider](./Register-AzureRmResourceProvider.md) - -[Unregister-AzureRmResourceProvider](./Unregister-AzureRmResourceProvider.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleAssignment.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleAssignment.md deleted file mode 100644 index e68e2ad7c8..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleAssignment.md +++ /dev/null @@ -1,445 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 488229AF-FD6D-4E1B-B3DA-E57CA781D91E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermroleassignment -schema: 2.0.0 ---- - -# Get-AzureRmRoleAssignment - -## SYNOPSIS -Lists Azure RBAC role assignments at the specified scope. -By default it lists all role assignments in the selected Azure subscription. -Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Get-AzureRmRoleAssignment [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -Get-AzureRmRoleAssignment -ObjectId <Guid> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -Get-AzureRmRoleAssignment [-ObjectId <Guid>] -RoleDefinitionId <Guid> [-Scope <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SignInNameParameterSet -``` -Get-AzureRmRoleAssignment -SignInName <String> [-RoleDefinitionName <String>] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> - [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] -Scope <String> - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Get-AzureRmRoleAssignment -ServicePrincipalName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupParameterSet -``` -Get-AzureRmRoleAssignment -ResourceGroupName <String> [-RoleDefinitionName <String>] - [-IncludeClassicAdministrators] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceParameterSet -``` -Get-AzureRmRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> - [-ParentResource <String>] [-RoleDefinitionName <String>] [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeParameterSet -``` -Get-AzureRmRoleAssignment [-RoleDefinitionName <String>] -Scope <String> [-IncludeClassicAdministrators] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-AzureRMRoleAssignment command to list all role assignments that are effective on a scope. -Without any parameters, this command returns all the role assignments made under the subscription. -This list can be filtered using filtering parameters for principal, role and scope. -The subject of the assignment must be specified. -To specify a user, use SignInName or Azure AD ObjectId parameters. -To specify a security group, use Azure AD ObjectId parameter. -And to specify an Azure AD application, use ServicePrincipalName or ObjectId parameters. -The role that is being assigned must be specified using the RoleDefinitionName parameter. -The scope at which access is being granted may be specified. -It defaults to the selected subscription. -The scope of the assignment can be specified using one of the following parameter combinations - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\>. -This will filter assignments that are effective at that particular scope i.e. -all assignments at that scope and above. - b. -ResourceGroupName - Name of any resource group under the subscription. -This will filter assignments effective at the specified resource group - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription and will filter assignments effective at that resource scope. -To determine what access a particular user has in the subscription, use the ExpandPrincipalGroups switch. -This will list all roles assigned to the user, and to the groups that the user is member of. -Use the IncludeClassicAdministrators switch to also display the subscription admins and co-admins. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRoleAssignment -``` - -List all role assignments in the subscription - -### Example 2 -``` -PS C:\> Get-AzureRmRoleAssignment -ResourceGroupName testRG -SignInName john.doe@contoso.com -``` - -Gets all role assignments made to user john.doe@contoso.com, and the groups of which he is member, at the testRG scope or above. - -### Example 3 -``` -PS C:\> Get-AzureRmRoleAssignment -ServicePrincipalName "http://testapp1.com" -``` - -Gets all role assignments of the specified service principal - -### Example 4 -``` -PS C:\> Get-AzureRmRoleAssignment -Scope "/subscriptions/96231a05-34ce-4eb4-aa6a-70759cbb5e83/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" -``` - -Gets role assignments at the 'site1' website scope. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ObjectIdParameterSet, SignInNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeClassicAdministrators -If specified, also lists subscription classic administrators (co-admins, service admins, etc.) role assignments. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The Azure AD ObjectId of the User, Group or Service Principal. -Filters all assignments that are made to the specified principal. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy of the resource specified using ResourceName parameter. -Must be used in conjunction with ResourceGroupName, ResourceType, and ResourceName parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. -Lists role assignments that are effective at the specified resource group. -When used in conjunction with ResourceName, ResourceType, and ParentResource parameters, the command lists assignments effective at resources within the resource group. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Must be used in conjunction with ResourceGroupName, ResourceType, and (optionally)ParentResource parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Must be used in conjunction with ResourceGroupName, ResourceName, and (optionally)ParentResource parameters. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the Role that is assigned to the principal. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Role that is assigned to the principal i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet, ResourceGroupParameterSet, ResourceParameterSet, ScopeParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment. -In the format of relative URI. -For e.g. -/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG. -It must start with "/subscriptions/{id}". -The command filters all assignments that are effective at that scope. - -```yaml -Type: System.String -Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet, ScopeParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The ServicePrincipalName of the service principal. -Filters all assignments that are made to the specified Azure AD application. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet, SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. -Filters all assignments that are made to the specified user. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, SignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Remove-AzureRmRoleAssignment](./Remove-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleDefinition.md deleted file mode 100644 index 4bee5dff25..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Get-AzureRmRoleDefinition.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 7740AC3B-F643-4F8D-8DC5-ACBF59323BD8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/get-azurermroledefinition -schema: 2.0.0 ---- - -# Get-AzureRmRoleDefinition - -## SYNOPSIS -Lists all Azure RBAC roles that are available for assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RoleDefinitionNameParameterSet -``` -Get-AzureRmRoleDefinition [[-Name] <String>] [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### RoleDefinitionIdParameterSet -``` -Get-AzureRmRoleDefinition -Id <Guid> [-Scope <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### RoleDefinitionCustomParameterSet -``` -Get-AzureRmRoleDefinition [-Scope <String>] [-Custom] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -Use the Get-AzureRmRoleDefinition command with a particular role name to view its details. -To inspect individual operations that a role grants access to, review the Actions and NotActions properties of the role. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmRoleDefinition -Name Reader -``` - -Get the Reader role definition - -### Example 2 -``` -PS C:\> Get-AzureRmRoleDefinition -``` - -Lists all RBAC role definitions - -## PARAMETERS - -### -Custom -If specified, only displays the custom created roles in the directory. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: RoleDefinitionCustomParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Guid -Parameter Sets: RoleDefinitionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Role definition name. -For e.g. -Reader, Contributor, Virtual Machine Contributor. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionNameParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Role definition scope. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Parameters: Scope (ByValue) - -### System.Guid - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Invoke-AzureRmResourceAction.md b/azurermps-2.5.0/AzureRm.Resources/Invoke-AzureRmResourceAction.md deleted file mode 100644 index 6e0d65a75e..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Invoke-AzureRmResourceAction.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 427F7300-0FEB-4F28-9C1D-27592AEBF6A0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/invoke-azurermresourceaction -schema: 2.0.0 ---- - -# Invoke-AzureRmResourceAction - -## SYNOPSIS -Invokes an action on a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceId <String> - [-ODataQuery <String>] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> - -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] - [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Invoke-AzureRmResourceAction [-Parameters <Hashtable>] -Action <String> -ResourceName <String> - -ResourceType <String> [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] - [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Invoke-AzureRmResourceAction** cmdlet invokes an action on a specified Azure resource. -To get a list of supported actions, use the Azure Resource Explorer tool. - -## EXAMPLES - -## PARAMETERS - -### -Action -Specifies the name of the action to invoke. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ActionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the type of the extension resource. -For instance: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies parameters, as a hash table, for the action that this cmdlet invokes. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Object - -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group in which this cmdlet invokes an action. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID of the resource on which this cmdlet invokes an action. -The ID includes the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource of the resource on which this cmdlet invokes an action. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Move-AzureRmResource.md b/azurermps-2.5.0/AzureRm.Resources/Move-AzureRmResource.md deleted file mode 100644 index a127488ddb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Move-AzureRmResource.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 60BED40A-EEA4-4667-93E9-8A9B35037726 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/move-azurermresource -schema: 2.0.0 ---- - -# Move-AzureRmResource - -## SYNOPSIS -Moves a resource to a different resource group or subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Move-AzureRmResource -DestinationResourceGroupName <String> [-DestinationSubscriptionId <Guid>] - -ResourceId <String[]> [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Move-AzureRmResource** cmdlet moves existing resources to a different resource group. -That resource group can be in a different subscription. - -## EXAMPLES - -### Example 1: Move a resource to a resource group -``` -PS C:\>$Resource = Get-AzureRmResource -ResourceType "Microsoft.ClassicCompute/storageAccounts" -ResourceName "ContosoStorageAccount" -PS C:\> Move-AzureRmResource -ResourceId $Resource.ResourceId -DestinationResourceGroupName "ResourceGroup14" -``` - -The first command gets a resource named ContosoStorageAccount by using the Get-AzureRmResource cmdlet, and then stores that resource in the $Resource variable. -The second command moves that resource into the resource group named ResourceGroup14. -The command identifies the resource to move by using the **ResourceId** property of $Resource. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: TargetResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationSubscriptionId -Specifies the ID of the subscription into which this cmdlet moves resources . - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: (All) -Aliases: Id, SubscriptionId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceId -Specifies an array of IDs of the resources that this cmdlet moves. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADAppCredential.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADAppCredential.md deleted file mode 100644 index 43ad15fe08..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADAppCredential.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 98836BC0-AB4F-4F24-88BE-E7DD350B71E8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadappcredential -schema: 2.0.0 ---- - -# New-AzureRmADAppCredential - -## SYNOPSIS -Adds a credential to an existing application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithPasswordParameterSet (Default) -``` -New-AzureRmADAppCredential -ObjectId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectIdWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ObjectId <Guid> -CertValue <String> [-StartDate <DateTime>] [-EndDate <DateTime>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ApplicationId <Guid> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithPasswordParameterSet -``` -New-AzureRmADAppCredential -ApplicationId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordParameterSet -``` -New-AzureRmADAppCredential -DisplayName <String> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithCertValueParameterSet -``` -New-AzureRmADAppCredential -DisplayName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithCertValueParameterSet -``` -New-AzureRmADAppCredential -ApplicationObject <PSADApplication> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordParameterSet -``` -New-AzureRmADAppCredential -ApplicationObject <PSADApplication> -Password <SecureString> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmADAppCredential cmdlet can be used to add a new credential or to roll credentials for an application. -The application is identified by supplying either the application object id or application Id. - -## EXAMPLES - -### Example 1 - Create a new application credential using a password - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADAppCredential -ObjectId 1f89cf81-0146-4f4e-beae-2007d0668416 -Password $SecureStringPassword -``` - -A new password credential is added to the existing appplication with object id '1f89cf81-0146-4f4e-beae-2007d0668416'. - -### Example 2 - Create a new application credential using a certificate - -``` -PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate -PS C:\> $cer.Import("C:\myapp.cer") -PS C:\> $binCert = $cer.GetRawCertData() -PS C:\> $credValue = [System.Convert]::ToBase64String($binCert) -PS C:\> New-AzureRmADAppCredential -ApplicationId 4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58 -CertValue $credValue -StartDate $cer.GetEffectiveDateString() -EndDate $cer.GetExpirationDateString() -``` - -The supplied base64 encoded public X509 certificate ("myapp.cer") is added to the existing application with application id '4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58'. - -### Example 3 - Create a new application credential using piping - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> Get-AzureRmADApplication -ObjectId 1f89cf81-0146-4f4e-beae-2007d0668416 | New-AzureRmADAppCredential -Password $SecureStringPassword -``` - -Gets the application with object id '1f89cf81-0146-4f4e-beae-2007d0668416' and pipes that to the New-AzureRmADAppCredential to create a new application credential for that application with the given password. - -## PARAMETERS - -### -ApplicationId -The application id of the application to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithCertValueParameterSet, ApplicationIdWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to add the credentials to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithCertValueParameterSet, ApplicationObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithCertValueParameterSet, ApplicationIdWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithCertValueParameterSet, ApplicationObjectWithCertValueParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithPasswordParameterSet, DisplayNameWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. The default end date value is one year from today. For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationObjectIdWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationObjectIdWithPasswordParameterSet, ApplicationIdWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: DisplayNameWithPasswordParameterSet, ApplicationObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. The default start date value is today. For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADApplication.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADApplication.md deleted file mode 100644 index 7e8a2d55c6..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADApplication.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: F58FD77E-2946-44B1-B410-6E983FC20E21 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadapplication -schema: 2.0.0 ---- - -# New-AzureRmADApplication - -## SYNOPSIS -Creates a new azure active directory application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationWithoutCredentialParameterSet (Default) -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordPlainParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordCredentialParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -PasswordCredentials <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyPlainParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyCredentialParameterSet -``` -New-AzureRmADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>] - [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -KeyCredentials <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new azure active directory application. - -## EXAMPLES - -### Example 1 - Create new AAD application. - -``` -PS C:\> New-AzureRmADApplication -DisplayName "NewApplication" -HomePage "https://www.microsoft.com" -IdentifierUris "http://NewApplication" -``` - -Creates a new azure active directory application without any credentials. - -### Example 2 - Create new AAD application with password. - -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADApplication -DisplayName "NewApplication" -HomePage "https://www.microsoft.com" -IdentifierUris "http: -//NewApplication" -Password $SecureStringPassword -``` - -Creates a new azure active directory application and associates password credentials with it. - -## PARAMETERS - -### -AvailableToOtherTenants -The value specifying whether the application is a single tenant or a multi-tenant. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationWithKeyPlainParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndDate -The effective end date of the credential usage. -The default end date value is one year from today. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -The URL to the application homepage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentifierUris -The URIs that identify the application. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyCredentials -The list of certificate credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordCredentials -The list of password credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationWithPasswordCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplyUrls -The application reply urls. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.String[] - -### System.Boolean - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADGroup.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADGroup.md deleted file mode 100644 index e23f4cb978..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADGroup.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadgroup -schema: 2.0.0 ---- - -# New-AzureRmADGroup - -## SYNOPSIS -Creates a new active directory group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmADGroup -DisplayName <String> -MailNickname <String> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new active directory group. - -## EXAMPLES - -### Example 1 - Create a new AD group - -``` -PS C:\> New-AzureRmADGroup -DisplayName "MyGroupDisplayName" -MailNickname "myemail@domain.com" -``` - -Creates a new AD group with the name "MyGroupDisplayName" and the mail nickname "myemail@domain.com". - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailNickname -The mail nickname for the group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADServicePrincipal.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADServicePrincipal.md deleted file mode 100644 index b71657b17f..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,599 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D602F910-B26F-473D-B5B6-C7BDFB0A14CB -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadserviceprincipal -schema: 2.0.0 ---- - -# New-AzureRmADServicePrincipal - -## SYNOPSIS -Creates a new azure active directory service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmADServicePrincipal [-ApplicationId <Guid>] [-DisplayName <String>] [-Password <SecureString>] - [-StartDate <DateTime>] [-EndDate <DateTime>] [-Scope <String>] [-Role <String>] [-SkipAssignment] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -PasswordCredential <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationId <Guid> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -Password <SecureString> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -PasswordCredential <PSADPasswordCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -DisplayName <String> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithoutCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -Password <SecureString> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ApplicationObjectWithPasswordCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> - -PasswordCredential <PSADPasswordCredential[]> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ApplicationObjectWithKeyPlainParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithKeyCredentialParameterSet -``` -New-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> -KeyCredential <PSADKeyCredential[]> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new azure active directory service principal. The default parameter set uses default values for parameters if the user does not provide one for them. For more information on the default values used, please see the description for the given parameters below. -This cmdlet has the ability to assign a role to the service principal with the `Role` and `Scope` parameters; if neither of these parameters are provided, no role will be assigned to the service principal. The default values for the `Role` and `Scope` parameters are "Contributor" and the current subscription, respectively (_note_: the defaults are only used when the user provides a value for one of the two parameters, but not the other). -The cmdlet also implicitly creates an application and sets its properties (if the ApplicationId is not provided). In order to update the application specific parameters please use Set-AzureRmADApplication cmdlet. - -## EXAMPLES - -### Example 1 - Simple AD service principal creation - -``` -PS C:\> New-AzureRmADServicePrincipal - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal -``` - -The above command creates an AD service principal using default values for parameters not provided. Since an application id was not provided, an application was created for the service principal. Since no values were provided for `Role` or `Scope`, the created service principal does not have any permissions. - -### Example 2 - Simple AD service principal creation with a specified role and default scope - -``` -PS C:\> New-AzureRmADServicePrincipal -Role Reader - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Reader" permissions over the current subscription (since no value was provided for the `Scope` parameter). - -### Example 3 - Simple AD service principal creation with a specified scope and default role - -``` -PS C:\> New-AzureRmADServicePrincipal -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Contributor' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Contributor" permissions (since no value was provided for the `Role` parameter) over the provided resource group scope. - -### Example 4 - Simple AD service principal creation with a specified scope and role - -``` -PS C:\> New-AzureRmADServicePrincipal -Role Reader -Scope /subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup - -Secret : System.Security.SecureString -ServicePrincipalNames : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, http://azure-powershell-05-22-2018-18-23-43} -ApplicationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -DisplayName : azure-powershell-05-22-2018-18-23-43 -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal - -WARNING: Assigning role 'Reader' over scope '/subscriptions/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/resourceGroups/myResourceGroup' to the new service principal. -``` - -The above command creates an AD service principal using the default values for parameters not provided. Since the application id was not provided, an application was created for the service principal. The service principal was created with "Reader" permissions over the provided resource group scope. - -### Example 5 - Create a new AD service principal using application id with role assignment - -``` -PS C:\> New-AzureRmADServicePrincipal -ApplicationId 34a28ad2-dec4-4a41-bc3b-d22ddf90000e - -ServicePrincipalNames : {34a28ad2-dec4-4a41-bc3b-d22ddf90000e, http://my-temp-app} -ApplicationId : 34a28ad2-dec4-4a41-bc3b-d22ddf90000e -DisplayName : my-temp-app -Id : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -Type : ServicePrincipal -``` - -Creates a new AD service principal for the application with application id '34a28ad2-dec4-4a41-bc3b-d22ddf90000e'. Since no values were provided for `Role` or `Scope`, the created service principal does not have any permissions. - -### Example 6 - Create a new AD service principal using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 3ede3c26-b443-4e0b-9efc-b05e68338dc3 | New-AzureRmADServicePrincipal -``` - -Gets the application with object id '3ede3c26-b443-4e0b-9efc-b05e68338dc3' and pipes that to the New-AzureRmADServicePrincipal cmdlet to create a new AD service principal for that application. - -## PARAMETERS - -### -ApplicationId -The unique application id for a service principal in a tenant. -Once created this property cannot be changed. -If an application id is not specified, one will be generated. - -```yaml -Type: System.Guid -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ApplicationWithoutCredentialParameterSet, ApplicationWithPasswordPlainParameterSet, ApplicationWithPasswordCredentialParameterSet, ApplicationWithKeyPlainParameterSet, ApplicationWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationObject -The object representing the application for which the service principal is created. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithoutCredentialParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithPasswordCredentialParameterSet, ApplicationObjectWithKeyPlainParameterSet, ApplicationObjectWithKeyCredentialParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: ApplicationWithKeyPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. If a display name is not provided, this value will default to 'azure-powershell-MM-dd-yyyy-HH-mm-ss', where the suffix is the time of application creation. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithoutCredentialParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithPasswordCredentialParameterSet, DisplayNameWithKeyPlainParameterSet, DisplayNameWithKeyCredentialParameterSet -Aliases: - -Required: True -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. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: SimpleParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyCredential -The collection of key credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationWithKeyCredentialParameterSet, DisplayNameWithKeyCredentialParameterSet -Aliases: KeyCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] -Parameter Sets: ApplicationObjectWithKeyCredentialParameterSet -Aliases: KeyCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the service principal. If a password is not provided, a random GUID will be generated and used as the password. - -```yaml -Type: System.Security.SecureString -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationWithPasswordPlainParameterSet, DisplayNameWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ApplicationObjectWithPasswordPlainParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordCredential -The collection of password credentials associated with the application. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationWithPasswordCredentialParameterSet, DisplayNameWithPasswordCredentialParameterSet -Aliases: PasswordCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] -Parameter Sets: ApplicationObjectWithPasswordCredentialParameterSet -Aliases: PasswordCredentials - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Role -The role that the service principal has over the scope. If a value for `Scope` is provided, but no value is provided for `Role`, then `Role` will default to the 'Contributor' role. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The scope that the service principal has permissions on. If a value for `Role` is provided, but no value is provided for `Scope`, then `Scope` will default to the current subscription. - -```yaml -Type: System.String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAssignment -If set, will skip creating the default role assignment for the service principal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: SimpleParameterSet, ApplicationObjectWithPasswordPlainParameterSet, ApplicationObjectWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: System.DateTime -Parameter Sets: ApplicationWithPasswordPlainParameterSet, ApplicationWithKeyPlainParameterSet, DisplayNameWithPasswordPlainParameterSet, DisplayNameWithKeyPlainParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADPasswordCredential[] - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADKeyCredential[] - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSADServicePrincipalWrapper - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Remove-AzureRmADServicePrincipal](./Remove-AzureRmADServicePrincipal.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADSpCredential.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADSpCredential.md deleted file mode 100644 index 11c71949b3..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADSpCredential.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 063BAA79-484D-48CF-9170-3808813752BD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermadspcredential -schema: 2.0.0 ---- - -# New-AzureRmADSpCredential - -## SYNOPSIS -Adds a credential to an existing service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SpObjectIdWithPasswordParameterSet (Default) -``` -New-AzureRmADSpCredential -ObjectId <Guid> [-Password <SecureString>] [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SpObjectIdWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ObjectId <Guid> -CertValue <String> [-StartDate <DateTime>] [-EndDate <DateTime>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalName <String> -CertValue <String> [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithPasswordParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalName <String> [-Password <SecureString>] [-StartDate <DateTime>] - [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServicePrincipalObjectWithCertValueParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> -CertValue <String> - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ServicePrincipalObjectWithPasswordParameterSet -``` -New-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> [-Password <SecureString>] - [-StartDate <DateTime>] [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmADSpCredential cmdlet can be used to add a new credential or to roll credentials for a service principal. -The service principal is identified by supplying either the object id or service principal name. - -## EXAMPLES - -### Example 1 - Create a new service principal credential using a generated password - -``` -PS C:\> New-AzureRmADSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 - -Secret : System.Security.SecureString -StartDate : 11/12/2018 9:36:05 PM -EndDate : 11/12/2019 9:36:05 PM -KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Type : Password -``` - -A new password credential is added to the existing service principal with object id '1f99cf81-0146-4f4e-beae-2007d0668476'. - -### Example 2 - Create a new service principal credential using a certificate - -``` -PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate -PS C:\> $cer.Import("C:\myapp.cer") -PS C:\> $binCert = $cer.GetRawCertData() -PS C:\> $credValue = [System.Convert]::ToBase64String($binCert) -PS C:\> New-AzureRmADSpCredential -ServicePrincipalName "http://test123" -CertValue $credValue -StartDate $cer.GetEffectiveDateString() -EndDate $cer.GetExpirationDateString() -``` - -The supplied base64 encoded public X509 certificate ("myapp.cer") is added to the existing service principal using its SPN. - -### Example 3 - Create a new service principal credential using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 | New-AzureRmADSpCredential - -Secret : System.Security.SecureString -StartDate : 11/12/2018 9:36:05 PM -EndDate : 11/12/2019 9:36:05 PM -KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Type : Password -``` - -Gets the service principal with object id '1f99cf81-0146-4f4e-beae-2007d0668476' and pipes that to the New-AzureRmADSpCredential to create a new service principal credential for that service principal with a generated password. - -## PARAMETERS - -### -CertValue -The value of the "asymmetric" credential type. -It represents the base 64 encoded certificate. - -```yaml -Type: System.String -Parameter Sets: SpObjectIdWithCertValueParameterSet, SPNWithCertValueParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ServicePrincipalObjectWithCertValueParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. -For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to add the credentials to. - -```yaml -Type: System.Guid -Parameter Sets: SpObjectIdWithPasswordParameterSet, SpObjectIdWithCertValueParameterSet -Aliases: ServicePrincipalObjectId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -The password to be associated with the application. - -```yaml -Type: System.Security.SecureString -Parameter Sets: SpObjectIdWithPasswordParameterSet, SPNWithPasswordParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: ServicePrincipalObjectWithPasswordParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to add the credentials to. - -```yaml -Type: System.String -Parameter Sets: SPNWithCertValueParameterSet, SPNWithPasswordParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to add the credentials to. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: ServicePrincipalObjectWithCertValueParameterSet, ServicePrincipalObjectWithPasswordParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StartDate -The effective start date of the credential usage. -The default start date value is today. -For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from. - -```yaml -Type: System.DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -### System.Security.SecureString - -### System.DateTime - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADCredential - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSADCredentialWrapper - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[Remove-AzureRmADSpCredential](./Remove-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADUser.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADUser.md deleted file mode 100644 index 528824db3d..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmADUser.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 86D8965D-D999-48A4-A4EE-9E054E5486EE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermaduser -schema: 2.0.0 ---- - -# New-AzureRmADUser - -## SYNOPSIS -Creates a new active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmADUser -DisplayName <String> -UserPrincipalName <String> -Password <SecureString> - [-ImmutableId <String>] [-MailNickname <String>] [-ForceChangePasswordNextLogin] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Creates a new active directory user (work/school account also popularly known as org-id). -For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#CreateUser - -## EXAMPLES - -### Example 1 - Create a new AD user -``` -PS C:\> $SecureStringPassword = ConvertTo-SecureString -String "password" -AsPlainText -Force -PS C:\> New-AzureRmADUser -DisplayName "MyDisplayName" -UserPrincipalName "myemail@domain.com" -Password $SecureStringPassword -MailNickname "MyMailNickName" -``` - -Creates a new AD user with the name "MyDisplayName" and user principal name "myemail@domain.com" in a tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceChangePasswordNextLogin -It must be specified if the user must change the password on the next successful login (true). -Default behavior is (false) to not change the password on the next successful login. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImmutableId -It needs to be specified only if you are using a federated domain for the user's user principal name (upn) property. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailNickname -The mail alias for the user. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Password for the user. -It must meet the tenant's password complexity requirements. -It is recommended to set a strong password. - -```yaml -Type: System.Security.SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name. -Example-'someuser@contoso.com'. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Security.SecureString - -### System.Management.Automation.SwitchParameter - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - - - -[Remove-AzureRmADUser](./Remove-AzureRmADUser.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmDeployment.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmDeployment.md deleted file mode 100644 index ae6de2a0c0..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmDeployment.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermdeployment -schema: 2.0.0 ---- - -# New-AzureRmDeployment - -## SYNOPSIS -Creat a deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterObject <Hashtable> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterObject <Hashtable> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterFile <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterFile <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterUri <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateParameterUri <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -New-AzureRmDeployment [-Name <String>] -Location <String> [-DeploymentDebugLogLevel <String>] [-AsJob] - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmDeployment** cmdlet adds a deployment at the current subscription scope. -This includes the resources that the deployment requires. - -An Azure resource is a user-managed Azure entity. A resource can live in a resource group, like database server, database, website, virtual machine, or Storage account. -Or, it can be a subscription level resource, like role definition, policy definition, etc. - -To add resources to a resource group, use the **New-AzureRmDeployment** which creates a deployment at a resource group. -The **New-AzureRmDeployment** cmdlet creates a deployment at the current subscription scope, which deploys subscription level resources. - -To add a deployment at subscription, specify the location and a template. -The location tells Azure Resource Manager where to store the deployment data. The template is a JSON string that contains individual resources to be deployed. -The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. - -To use a custom template for the deployment, specify the *TemplateFile* parameter or *TemplateUri* parameter. -Each template has parameters for configurable properties. -To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. -To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. -Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. - -## EXAMPLES - -### Example 1: Use a custom template and parameter file to create a deployment -``` -PS C:\>New-AzureRmDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -TemplateVersion "2.1" -``` - -This command creates a new deployment at the current subscription scope by using a custom template and a template file on disk. -The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. -It uses the *TemplateVersion* parameter to specify the version of the template. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentDebugLogLevel -The deployment debug log level. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location to store deployment data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the deployment it's going to create. -Only valid when a template is used. -When a template is used, if the user doesn't specify a deployment name, use the current time, like "20131223140835". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DeploymentName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Local path to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -A file that has the template parameters. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -A hash table which represents the parameters. - -```yaml -Type: Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Uri to the template parameter file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Uri to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeployment - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplication.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplication.md deleted file mode 100644 index 37532e438a..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplication.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagedapplication -schema: 2.0.0 ---- - -# New-AzureRmManagedApplication - -## SYNOPSIS -Creates an Azure managed application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> -ManagedResourceGroupName <String> - [-ManagedApplicationDefinitionId <String>] -Location <String> [-Parameter <String>] -Kind <ApplicationKind> - [-Plan <Hashtable>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmManagedApplication** cmdlet creates an Azure Managed Application. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-AzureRmManagedApplication -Name "myManagedApplication" -ResourceGroupName myRG -ManagedResourceGroupName myManagedRG -ManagedApplicationDefinitionId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Solutions/applicationDefinitions/myAppDef" -Location eastus2euap -Kind ServiceCatalog -``` - -This command creates a managed application - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -The managed application kind. -One of marketplace or servicecatalog - -```yaml -Type: ApplicationKind -Parameter Sets: (All) -Aliases: -Accepted values: ServiceCatalog, MarketPlace - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The resource location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedApplicationDefinitionId -The managed resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedResourceGroupName -The managed resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The JSON formatted string of parameters for managed application. -This can either be a path to a file name or uri containing the parameters, or the parameters 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 -``` - -### -Plan -A hash table which represents managed application plan properties. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplicationDefinition.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index 90e0e6df57..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermmanagedapplicationdefinition -schema: 2.0.0 ---- - -# New-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Creates a managed application definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> -DisplayName <String> - -Description <String> -Location <String> -LockLevel <ApplicationLockLevel> [-PackageFileUri <String>] - [-CreateUiDefinition <String>] [-MainTemplate <String>] -Authorization <String[]> [-Tag <Hashtable>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmManagedApplicationDefinition** cmdlet creates a managed application definition. - -## EXAMPLES - -### Example 1 -``` -PS> New-AzureRmManagedApplicationDefinition -Name myAppDef -ResourceGroupName myRG -DisplayName test -Description "sample description" -Location westus -LockLevel ReadOnly -PackageFileUri https://sample.blob.core.windows.net/files/myPackage.zip -Authorization <principalId:roleDefinitionId> -``` - -This command creates a managed application definition - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -The managed application definition authorization. -Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 managed application definition description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The managed application definition display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -The resource location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockLevel -The level of the lock for managed application definition. - -```yaml -Type: ApplicationLockLevel -Parameter Sets: (All) -Aliases: Level -Accepted values: None, CanNotDelete, ReadOnly - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageFileUri -The managed application definition package file uri. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hashtable which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.ApplicationLockLevel -System.String[] -System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyAssignment.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyAssignment.md deleted file mode 100644 index ead4eda5ce..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,483 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: BA40BD11-8167-48D7-AC71-72B2FD9924F2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicyassignment -schema: 2.0.0 ---- - -# New-AzureRmPolicyAssignment - -## SYNOPSIS -Creates a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### DefaultParameterSet (Default) -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] [-PolicySetDefinition <PSObject>] [-Metadata <String>] - [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicyParameterObjectParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>] - -PolicyParameterObject <Hashtable> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] - [-Location <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicyParameterStringParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>] - -PolicyParameter <String> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicySetParameterObjectParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject> - -PolicyParameterObject <Hashtable> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] - [-Location <String>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### PolicySetParameterStringParameterSet -``` -New-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject> - -PolicyParameter <String> [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicyAssignment** cmdlet creates a policy assignment. -Specify a policy and scope. - -## EXAMPLES - -### Example 1: Policy assignment at resource group level -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -Name 'VirtualMachinePolicy' -PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy at the level of the resource group identified by the **ResourceId** property of $ResourceGroup. - -### Example 2: Policy assignment at resource group level with policy parameter object -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} -PS C:\> $Locations = Get-AzureRmLocation | where displayname -like '*east*' -PS C:\> $AllowedLocations = @{'listOfAllowedLocations'=($Locations.location)} -PS C:\> New-AzureRmPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameterObject $AllowedLocations -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command gets the built-in policy definition for allowed locations by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores that object in the $Policy variable. -The third and fourth commands create an object containing all Azure regions with "east" in the name. -The commands store that object in the $AllowedLocations variable. -The final command assigns the policy in $Policy at the level of a resource group using the policy parameter object in $AllowedLocations. -The **ResourceId** property of $ResourceGroup identifies the resource group. - -### Example 3: Policy assignment at resource group level with policy parameter file -Create a file called _AllowedLocations.json_ in the local working directory with the following content. - -``` -{ - "listOfAllowedLocations": { - "value": [ - "westus", - "westeurope", - "japanwest" - ] - } -} -``` - -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -BuiltIn | Where-Object {$_.Properties.DisplayName -eq 'Allowed locations'} -PS C:\> New-AzureRmPolicyAssignment -Name 'RestrictLocationPolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -PolicyParameter .\AllowedLocations.json -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the built-in policy definition for allowed locations by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy at the resource group identified by the **ResourceId** property of $ResourceGroup using the policy parameter file AllowedLocations.json from the local working directory. - -### Example 4: Policy assignment with a managed identity -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $Policy = Get-AzureRmPolicyDefinition -Name 'VirtualMachinePolicy' -PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -Scope $ResourceGroup.ResourceId -Location 'eastus' -AssignIdentity -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable. -The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable. -The final command assigns the policy in $Policy to the resource group. A managed identity is automatically created and assigned to the policy assignment. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: System.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata for the new policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.String -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 assignment. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotScope -The not scopes for policy assignment. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -Specifies a policy, as a **PsPolicyDefinition** object that contains the policy rule. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyParameter -The policy parameter file path or policy parameter string. - -```yaml -Type: System.String -Parameter Sets: PolicyParameterStringParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyParameterObject -The policy parameter object. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: PolicyParameterObjectParameterSet, PolicySetParameterObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicySetDefinition -The policy set definition object. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which to assign the policy. -For instance, to assign a policy to a resource group, specify the following: -`/subscriptions/`subscription ID`/resourcegroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table which represents SKU properties. Defaults to the Free SKU with the values: `@{Name = 'A0'; Tier = 'Free'}`. To use the Standard SKU, use the values: `@{Name = 'A1'; Tier = 'Standard'}`. - -```yaml -Type: System.Collections.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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyDefinition.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyDefinition.md deleted file mode 100644 index c327c72f02..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 31F2AF24-488D-4CAF-A9C8-C8DAE76E031F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicydefinition -schema: 2.0.0 ---- - -# New-AzureRmPolicyDefinition - -## SYNOPSIS -Creates a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -New-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] -Policy <String> - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicyDefinition** cmdlet creates a policy definition that includes a policy rule in JavaScript Object Notation (JSON) format. - -## EXAMPLES - -### Example 1: Create a policy definition by using a policy file -``` -{ - "if": { - "field": "location", - "notIn": ["eastus", "westus", "centralus"] - }, - "then": { - "effect": "audit" - } -} -``` - -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -``` - -This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. Example content for the LocationPolicy.json file is provided above. - -### Example 2: Create a parameterized policy definition using inline parameters -``` -{ - "if": { - "field": "location", - "notIn": "[parameters('listOfAllowedLocations')]" - }, - "then": { - "effect": "audit" - } -} -``` - -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Parameter '{ "listOfAllowedLocations": { "type": "array" } }' -``` - -This command creates a policy definition named LocationDefinition that contains the policy rule specified in C:\LocationPolicy.json. The parameter definition for the policy rule is provided inline. - -### Example 3: Create a policy definition inline in a management group -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName Dept42 -DisplayName 'Virtual Machine policy definition' -Policy '{"if":{"source":"action","equals":"Microsoft.Compute/virtualMachines/write"},"then":{"effect":"deny"}}' -``` - -This command creates a policy definition named VMPolicyDefinition in management group Dept42. -The command specifies the policy as a string in valid JSON format. - -### Example 4: Create a policy definition inline with metadata -``` -PS C:\> New-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"Category":"Virtual Machine"}' -Policy '{"if":{"source":"action","equals":"Microsoft.Compute/virtualMachines/write"},"then":{"effect":"deny"}}' - - -Name : VMPolicyDefinition -ResourceId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition -ResourceName : VMPolicyDefinition -ResourceType : Microsoft.Authorization/policyDefinitions -SubscriptionId : 11111111-1111-1111-1111-111111111111 -Properties : @{displayName=VMPolicyDefinition; policyType=Custom; mode=All; metadata=; policyRule=} -PolicyDefinitionId : /subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Authorization/policyDefinitions/VMPolicyDefinition -``` - -This command creates a policy definition named VMPolicyDefinition with metadata indicating its category is "Virtual Machine". -The command specifies the policy as a string in valid JSON format. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.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 definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the new policy definition. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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: System.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: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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 containing the parameters declaration, or the parameters declaration as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Policy -Specifies a policy rule for the policy definition. -You can specify the path of a .json file or a string that contains the policy in JSON format. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the new policy definition. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicySetDefinition.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicySetDefinition.md deleted file mode 100644 index 7d5a9fe1b3..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermpolicysetdefinition -schema: 2.0.0 ---- - -# New-AzureRmPolicySetDefinition - -## SYNOPSIS -Creates a policy set definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -New-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] -PolicyDefinition <String> [-Parameter <String>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmPolicySetDefinition** cmdlet creates a policy set definition. - -## EXAMPLES - -### Example 1: Create a policy set definition by using a policy set file -``` -[ - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", - "parameters": { - "tagName": { - "value": "Business Unit" - }, - "tagValue": { - "value": "Finance" - } - } - }, - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" - } -] -``` - -``` -PS C:\> New-AzureRmPolicySetDefinition -Name 'VMPolicyDefinition' -PolicyDefinition C:\VMPolicySet.json -``` - -This command creates a policy set definition named VMPolicyDefinition that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. - -### Example 2: Create a parameterized policy set definition -``` -[ - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/2a0e14a6-b0a6-4fab-991a-187a4f81c498", - "parameters": { - "tagName": { - "value": "Business Unit" - }, - "tagValue": { - "value": "[parameters('buTagValue')]" - } - } - }, - { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/464dbb85-3d5f-4a1d-bb09-95a9b5dd19cf" - } -] -``` - -``` -PS C:\> New-AzureRmPolicySetDefinition -Name 'VMPolicyDefinition' -PolicyDefinition C:\VMPolicySet.json -Parameter '{ "buTagValue": { "type": "string" } }' -``` - -This command creates a parameterized policy set definition named VMPolicyDefinition that contains the policy definitions specified in C:\VMPolicy.json. Example content of the VMPolicy.json is provided above. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The display name for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the new policy set definition. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -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: System.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration for policy set definition. -This can either be a path to a file name containing the parameters declaration, or the parameters declaration as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -The policy set definition. This can either be a path to a file name containing the policy definitions, or the policy set definition as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the new policy set definition. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResource.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResource.md deleted file mode 100644 index 853a02980a..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResource.md +++ /dev/null @@ -1,442 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D6FF6BDD-4515-438D-B39D-C0BFC3342F4E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresource -schema: 2.0.0 ---- - -# New-AzureRmResource - -## SYNOPSIS -Creates a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceId <String> [-ODataQuery <String>] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -New-AzureRmResource [-Location <String>] [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-IsFullObject] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResource** cmdlet creates an Azure resource, such as a website, Azure SQL Database server, or Azure SQL Database, in a resource group. - -## EXAMPLES - -### Example 1: Create a resource -``` -PS> New-AzureRmResource -Location "West US" -Properties @{test="test"} -ResourceName TestSite06 -ResourceType microsoft.web/sites -ResourceGroupName ResourceGroup11 -Force -``` - -This command creates a resource that is a website in ResourceGroup11. - -### Example 2: Create a resource using splatting -``` -PS> $prop = @{ - Location = "West US" - Properties = @{test = "test"} - ResourceName = "TestSite06" - ResourceType = "microsoft.web/sites" - ResourceGroupName = "ResourceGroup11" - Force = $true -} - -PS> New-AzureRmResource @prop -``` - -This command creates a resource that is a website in ResourceGroup11. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -For instance, if the extension resource is a database, specify the following type: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsFullObject -Indicates that the object that the *Properties* parameter specifies is the full object. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Kind -Specifies the resource kind for the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource. -Specify data center location, such as Central US or Southeast Asia. -You can place a resource in any location that supports resources of that type. Resource groups can -contain resources from different locations. To determine which locations support each resource -type, use the Get-AzureLocation cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. This cmdlet appends this value to the request -in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -A hash table that represents resource plan properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies resource properties for the resource. Use this parameter to specify the values of -properties that are specific to a resource type. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: PropertyObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group where this cmdlet creates the resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, including the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource. For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table that represents sku properties. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResource - -## NOTES - -## RELATED LINKS - - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroup.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroup.md deleted file mode 100644 index 39b08b4342..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroup.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0632DAD6-F331-454F-9E7E-2164AB413E77 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcegroup -schema: 2.0.0 ---- - -# New-AzureRmResourceGroup - -## SYNOPSIS -Creates an Azure resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmResourceGroup -Name <String> -Location <String> [-Tag <Hashtable>] [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceGroup** cmdlet creates an Azure resource group. -You can create a resource group by using just a name and location, and then use the -New-AzureRmResource cmdlet to create resources to add to the resource group. -To add a deployment to an existing resource group, use the New-AzureRmResourceGroupDeployment -cmdlet. To add a resource to an existing resource group, use the **New-AzureRmResource** cmdlet. An -Azure resource is a user-managed Azure entity, such as a database server, database, or website. An -Azure resource group is a collection of Azure resources that are deployed as a unit. - -## EXAMPLES - -### Example 1: Create an empty resource group -``` -PS> New-AzureRmResourceGroup -Name RG01 -Location "South Central US" -``` - -This command creates a resource group that has no resources. You can use the -**New-AzureRmResource** or **New-AzureRmResourceGroupDeployment** cmdlets to add resources and -deployments to this resource group. - -### Example 2: Create an empty resource group using positional parameters -``` -PS> New-AzureRmResourceGroup RG01 "South Central US" -``` - -This command creates a resource group that has no resources. - -### Example 3: Create a resource group with tags -``` -PS> New-AzureRmResourceGroup -Name RG01 -Location "South Central US" -Tag @{Empty=$null; Department="Marketing"} -``` - -This command creates an empty resource group. This command is the same as the command in Example 1, -except that it assigns tags to the resource group. The first tag, named Empty, can be used to -identify resource groups that have no resources. The second tag is named Department and has a value -of Marketing. You can use a tag such as this one to categorize resource groups for administration -or budgeting. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the resource group. Specify an Azure data center location, such as West -US or Southeast Asia. You can place a resource group in any location. The resource group does not -have to be in the same location your Azure subscription or in the same location as its resources. -To determine which location supports each resource type, use the Get-AzureRmResourceProvider cmdlet -with the *ProviderNamespace* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the resource group. The resource name must be unique in the subscription. If a -resource group that has that name already exists, the command prompts you for confirmation before -replacing the existing resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroupName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} -To add or change a tag, you must replace the collection of tags for the resource group. -After you assign tags to resources and groups, you can use the *Tag* parameter of -Get-AzureRmResource and Get-AzureRmResourceGroup to search for resources and groups by tag name or -by name and value. You can use tags to categorize your resources, such as by department or cost -center, or to track notes or comments about the resources. -To get your predefined tags, use the Get-AzureRMTag cmdlet. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManagement.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroupDeployment.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 0f0c7be68c..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,430 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6E2F0D5E-E683-46F3-B48B-55C4864F3308 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcegroupdeployment -schema: 2.0.0 ---- - -# New-AzureRmResourceGroupDeployment - -## SYNOPSIS -Adds an Azure deployment to a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterObject <Hashtable> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterObject <Hashtable> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterFile <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterFile <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterUri <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateParameterUri <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -New-AzureRmResourceGroupDeployment [-Name <String>] -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-DeploymentDebugLogLevel <String>] [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] [-Force] - [-AsJob] -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceGroupDeployment** cmdlet adds a deployment to an existing resource group. -This includes the resources that the deployment requires. -An Azure resource is a user-managed Azure entity, such as a database server, database, website, virtual machine, or Storage account. -An Azure resource group is a collection of Azure resources that are deployed as a unit, such as the website, database server, and databases that are required for a financial website. -A resource group deployment uses a template to add resources to a resource group and publishes them so that they are available in Azure. -To add resources to a resource group without using a template, use the New-AzureRmResource cmdlet. -To add a resource group deployment, specify the name of an existing resource group and a resource group template. -A resource group template is a JSON string that represents a resource group for a complex cloud-based service, such as a web portal. -The template includes parameter placeholders for required resources and configurable property values, such as names and sizes. -You can find many templates in the Azure template gallery or you can create your own templates. -You can use the **Get-AzureRmResourceGroupGalleryTemplate** cmdlet to find a template in the gallery. -To use a custom template to create a resource group, specify the *TemplateFile* parameter or *TemplateUri* parameter. -Each template has parameters for configurable properties. -To specify values for the template parameters, specify the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Alternatively, you can use the template parameters that are dynamically added to the command when you specify a template. -To use dynamic parameters, type them at the command prompt, or type a minus sign (-) to indicate a parameter and use the Tab key to cycle through available parameters. -Template parameter values that you enter at the command prompt take precedence over values in a template parameter object or file. - -## EXAMPLES - -### Example 1: Use a custom template and parameter file to create a deployment -``` -PS C:\>New-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -``` - -This command creates a new deployment by using a custom template and a template file on disk. -The command uses the *TemplateFile* parameter to specify the template and the *TemplateParameterFile* parameter to specify a file that contains parameters and parameter values. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: -- RequestContent -- ResponseContent -- All -- None - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the deployment mode. The acceptable values for this parameter are: -- Complete -- Incremental -In complete mode, Resource Manager deletes resources that exist in the resource group but are not -specified in the template. In incremental mode, Resource Manager leaves unchanged resources that -exist in the resource group but are not specified in the template. - -```yaml -Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Incremental -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: DeploymentName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to deploy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollBackDeploymentName -Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollbackToLastDeployment -Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Specifies the full path of a JSON template file. -This can be a custom template or a gallery template that is saved as a JSON file, such as one created by using the **Save-AzureRmResourceGroupGalleryTemplate** cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -Specifies the full path of a JSON file that contains the names and values of the template parameters. -If a template has parameters, you must specify the parameter values with the *TemplateParameterFile* parameter or the *TemplateParameterObject* parameter. -Template parameters are dynamically added to the command when you specify a template. -To use the dynamic parameters, type a minus sign (-) to indicate a parameter name and then use the Tab key to cycle through the available parameters. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -Specifies a hash table of template parameter names and values. -For help with hash tables in Windows PowerShell, type `Get-Help about_Hash_Tables`. -If a template has parameters, you must specify parameter values. -Template parameters are dynamically added to the command when you specify a template. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Specifies the URI of a template parameters file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Specifies the URI of a JSON template file. -This file can be a custom template or a gallery template that is saved as a JSON file, such as by using **Save-AzureRmResourceGroupGalleryTemplate**. - -```yaml -Type: System.String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResourceGroupDeployment - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceLock.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceLock.md deleted file mode 100644 index 5f9933c4bf..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmResourceLock.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 6847ECFD-2E3D-46F6-ABE9-9D8E08C7858F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermresourcelock -schema: 2.0.0 ---- - -# New-AzureRmResourceLock - -## SYNOPSIS -Creates a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySpecifiedScope (Default) -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -Scope <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroup -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -New-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-TenantLevel] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLockId -``` -New-AzureRmResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmResourceLock** cmdlet creates a resource lock. - -## EXAMPLES - -### Example 1: Create a resource lock on a website -``` -PS C:\>New-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "My lock notes" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -``` - -This command creates a resource lock on a website. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockLevel -Specifies the level for the lock. -Currently, valid values are CanNotDelete, ReadOnly. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel -Parameter Sets: (All) -Aliases: Level - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockNotes -Specifies the notes for the lock. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Notes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of a resource group for which the lock applies or that contains the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -For instance, to specify a database, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name -To specify a resource group, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleAssignment.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleAssignment.md deleted file mode 100644 index 1a7e000183..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleAssignment.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: E460D108-2BF9-4F57-AF3D-13868DC73EA0 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermroleassignment -schema: 2.0.0 ---- - -# New-AzureRmRoleAssignment - -## SYNOPSIS -Assigns the specified RBAC role to the specified principal, at the specified scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -Scope <String> -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -New-AzureRmRoleAssignment -ObjectId <Guid> -Scope <String> -RoleDefinitionId <Guid> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -New-AzureRmRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-AllowDelegation] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -New-AzureRmRoleAssignment -ApplicationId <String> [-Scope <String>] -RoleDefinitionName <String> - [-AllowDelegation] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -Use the New-AzureRMRoleAssignment command to grant access. -Access is granted by assigning the appropriate RBAC role to them at the right scope. -To grant access to the entire subscription, assign a role at the subscription scope. -To grant access to a specific resource group within a subscription, assign a role at the resource group scope. -The subject of the assignment must be specified. -To specify a user, use SignInName or Azure AD ObjectId parameters. -To specify a security group, use Azure AD ObjectId parameter. -And to specify an Azure AD application, use ApplicationId or ObjectId parameters. -The role that is being assigned must be specified using the RoleDefinitionName parameter. -The scope at which access is being granted may be specified. -It defaults to the selected subscription. -The scope of the assignment can be specified using one of the following parameter combinations - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> - b. -ResourceGroupName - to grant access to the specified resource group. - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - to specify a particular resource within a resource group to grant access to. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName allen.young@live.com -RoleDefinitionName Reader -AllowDelegation -``` - -Grant Reader role access to a user at a resource group scope with the Role Assignment being available for delegation - -### Example 2 -``` -PS C:\> Get-AzureRMADGroup -SearchString "Christine Koch Team" - - DisplayName Type Id - ----------- ---- -------- - Christine Koch Team 2f9d4375-cbf1-48e8-83c9-2a0be4cb33fb - -PS C:\> New-AzureRmRoleAssignment -ObjectId 2f9d4375-cbf1-48e8-83c9-2a0be4cb33fb -RoleDefinitionName Contributor -ResourceGroupName rg1 -``` - -Grant access to a security group - -### Example 3 -``` -PS C:\> New-AzureRmRoleAssignment -SignInName john.doe@contoso.com -RoleDefinitionName Owner -Scope "/subscriptions/86f81fc3-b00f-48cd-8218-3879f51ff362/resourcegroups/rg1/providers/Microsoft.Web/sites/site1" -``` - -Grant access to a user at a resource (website) - -### Example 4 -``` -PS C:\> New-AzureRMRoleAssignment -ObjectId 5ac84765-1c8c-4994-94b2-629461bd191b -RoleDefinitionName "Virtual Machine Contributor" -ResourceName Devices-Engineering-ProjectRND -ResourceType Microsoft.Network/virtualNetworks/subnets -ParentResource virtualNetworks/VNET-EASTUS-01 -ResourceGroupName Network -``` - -Grant access to a group at a nested resource (subnet) - -### Example 5 -``` -PS C:\> $servicePrincipal = New-AzureRmADServicePrincipal -DisplayName "testServiceprincipal" -PS C:\> New-AzureRmRoleAssignment -RoleDefinitionName "Reader" -ApplicationId $servicePrincipal.ApplicationId -``` - -Grant reader access to a service principal - -## PARAMETERS - -### -AllowDelegation -The delegation flag while creating a Role assignment. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -The Application ID of the ServicePrincipal - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: SPN, ServicePrincipalName - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy(of the resource specified using ResourceName parameter). -Should only be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. -Creates an assignment that is effective at the specified resource group. -When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Should only be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Should only be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the RBAC role that needs to be assigned to the principal. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Name of the RBAC role that needs to be assigned to the principal i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceGroupWithSPNParameterSet, ResourceWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment. -In the format of relative URI. -For e.g. -"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". -If not specified, will create the role assignment at subscription level. -If specified, it should start with "/subscriptions/{id}". - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ScopeWithObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupWithSignInNameParameterSet, ResourceWithSignInNameParameterSet, ScopeWithSignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[Remove-AzureRmRoleAssignment](./Remove-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleDefinition.md b/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleDefinition.md deleted file mode 100644 index 131a1dee98..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/New-AzureRmRoleDefinition.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8300B143-E322-419E-BC98-DBA56DD90A59 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/new-azurermroledefinition -schema: 2.0.0 ---- - -# New-AzureRmRoleDefinition - -## SYNOPSIS -Creates a custom role in Azure RBAC. -Provide either a JSON role definition file or a PSRoleDefinition object as input. -First, use the Get-AzureRmRoleDefinition command to generate a baseline role definition object. -Then, modify its properties as required. -Finally, use this command to create a custom role using role definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -New-AzureRmRoleDefinition [-InputFile] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleDefinitionParameterSet -``` -New-AzureRmRoleDefinition [-Role] <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The New-AzureRmRoleDefinition cmdlet creates a custom role in Azure Role-Based Access Control. -Provide a role definition as an input to the command as a JSON file or a PSRoleDefinition object. -The input role definition MUST contain the following properties: -1) DisplayName: the name of the custom role -2) Description: a short description of the role that summarizes the access that the role grants. -3) Actions: the set of operations to which the custom role grants access. -Use Get-AzureRmProviderOperation to get the operation for Azure resource providers that can be secured using Azure RBAC. -Following are some valid operation strings: - - "*/read" grants access to read operations of all Azure resource providers. - - "Microsoft.Network/*/read" grants access to read operations for all resource types in the Microsoft.Network resource provider of Azure. - - "Microsoft.Compute/virtualMachines/*" grants access to all operations of virtual machines and its child resource types. -4) AssignableScopes: the set of scopes (Azure subscriptions or resource groups) in which the custom role will be available for assignment. -Using AssignableScopes you can make the custom role available for assignment in only the subscriptions or resource groups that need it, and not clutter the user experience for the rest of the subscriptions or resource groups. -Following are some valid assignable scopes: - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e", "/subscriptions/e91d47c4-76f3-4271-a796-21b4ecfe3624": makes the role available for assignment in two subscriptions. - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e": makes the role available for assignment in a single subscription. - - "/subscriptions/c276fc76-9cd4-44c9-99a7-4fd71546436e/resourceGroups/Network": makes the role available for assignment only in the Network resource group. -The input role definition MAY contain the following properties: -1) NotActions: the set of operations that must be excluded from the Actions to determine the effective actions for the custom role. -If there is a specific operation that you do not wish to grant access to in a custom role, it is convenient to use NotActions to exclude it, rather than specifying all operations other than that specific operation in Actions. -2) DataActions: the set of data operations to which the custom role grants access. -3) NotDataActions: the set of operations that must be excluded from the DataActions to determine the effective dataactions for the custom role. -If there is a specific data operation that you do not wish to grant access to in a custom role, it is convenient to use NotDataActions to exclude it, rather than specifying all operations other than that specific operation in Actions. -NOTE: If a user is assigned a role that specifies an operation in NotActions and also assigned another role grants access to the same operation - the user will be able to perform that operation. -NotActions is not a deny rule - it is simply a convenient way to create a set of allowed operations when specific operations need to be excluded. -Following is a sample json role definition that can be provided as input -{ - "Name": "Updated Role", - "Description": "Can monitor all resources and start and restart virtual machines", - "Actions": - \[ - "*/read", - "Microsoft.ClassicCompute/virtualmachines/restart/action", - "Microsoft.ClassicCompute/virtualmachines/start/action" - \], - "NotActions": - \[ - "*/write" - \], - "DataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" - \], - "NotDataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" - \], - "AssignableScopes": \["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\] -} - -## EXAMPLES - -### Create using PSRoleDefinitionObject -``` -PS C:\> $role = Get-AzureRmRoleDefinition -Name "Virtual Machine Contributor" - PS C:\> $role.Id = $null - PS C:\> $role.Name = "Virtual Machine Operator" - PS C:\> $role.Description = "Can monitor, start, and restart virtual machines." - PS C:\> $role.Actions.RemoveRange(0,$role.Actions.Count) - PS C:\> $role.Actions.Add("Microsoft.Compute/*/read") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/start/action") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/restart/action") - PS C:\> $role.Actions.Add("Microsoft.Compute/virtualMachines/downloadRemoteDesktopConnectionFile/action") - PS C:\> $role.Actions.Add("Microsoft.Network/*/read") - PS C:\> $role.Actions.Add("Microsoft.Storage/*/read") - PS C:\> $role.Actions.Add("Microsoft.Authorization/*/read") - PS C:\> $role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/read") - PS C:\> $role.Actions.Add("Microsoft.Resources/subscriptions/resourceGroups/resources/read") - PS C:\> $role.Actions.Add("Microsoft.Insights/alertRules/*") - PS C:\> $role.Actions.Add("Microsoft.Support/*") - PS C:\> $role.AssignableScopes.Clear() - PS C:\> $role.AssignableScopes.Add("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") - - PS C:\> New-AzureRmRoleDefinition -Role $role -``` - -### Create using JSON file -``` -PS C:\> New-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Role definition object. - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: RoleDefinitionParameterSet -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmProviderOperation](./Get-AzureRmProviderOperation.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[Set-AzureRmRoleDefinition](./Set-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmProviderFeature.md b/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmProviderFeature.md deleted file mode 100644 index 14829a09b7..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmProviderFeature.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 83EE33E5-18EF-4A7A-AEF2-E93D7A3CA541 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/register-azurermproviderfeature -schema: 2.0.0 ---- - -# Register-AzureRmProviderFeature - -## SYNOPSIS -Registers an Azure provider feature in your account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Register-AzureRmProviderFeature -FeatureName <String> -ProviderNamespace <String> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Register-AzureRmProviderFeature** cmdlet registers an Azure provider feature in your account. - -## EXAMPLES - -### Example 1: Register a feature -``` -PS C:\>Register-AzureRmProviderFeature -FeatureName AllowApplicationSecurityGroups -ProviderNamespace Microsoft.Network -``` - -This adds the AllowApplicationSecurityGroups feature for Microsoft.Network to your account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies a namespace for which this cmdlet registers a provider feature. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmProviderFeature](./Get-AzureRmProviderFeature.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmResourceProvider.md b/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmResourceProvider.md deleted file mode 100644 index 93a93ca36c..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Register-AzureRmResourceProvider.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D5067FD8-2FB1-413C-9F59-84E83A74343E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/register-azurermresourceprovider -schema: 2.0.0 ---- - -# Register-AzureRmResourceProvider - -## SYNOPSIS -Registers a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Register-AzureRmResourceProvider -ProviderNamespace <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Register-AzureRmResourceProvider** cmdlet registers an Azure resource provider. - -## EXAMPLES - -### Example 1: Register a provider -``` -PS C:\>Register-AzureRmResourceProvider -ProviderNamespace Microsoft.Network -``` - -This registers the Microsoft.Network provider for your account. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Unregister-AzureRmResourceProvider](./Unregister-AzureRmResourceProvider.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADAppCredential.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADAppCredential.md deleted file mode 100644 index 77ddb949d0..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADAppCredential.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C61FA834-BEBE-4DBF-888F-C6CB8CC95390 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadappcredential -schema: 2.0.0 ---- - -# Remove-AzureRmADAppCredential - -## SYNOPSIS -Removes a credential from an application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithKeyIdParameterSet (Default) -``` -Remove-AzureRmADAppCredential -ObjectId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithKeyIdParameterSet -``` -Remove-AzureRmADAppCredential -ApplicationId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationDisplayNameParameterSet -``` -Remove-AzureRmADAppCredential -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectWithKeyIdParameterSet -``` -Remove-AzureRmADAppCredential [-KeyId <Guid>] -ApplicationObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmADAppCredential cmdlet can be used to remove a credential key from an application in the case of a compromise or as part of credential key rollover expiration. -The application is identified by supplying either the object ID or AppId. -The credential to be removed is identified by its key ID. - -## EXAMPLES - -### Example 1 - Remove a specific credential from an application - -``` -PS C:\> Remove-AzureRmADAppCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb -``` - -Removes the credential with key id '9044423a-60a3-45ac-9ab1-09534157ebb' from the application with object id '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82'. - -### Example 2 - Remove all credentials from an application - -``` -PS C:\> Remove-AzureRmADAppCredential -ApplicationId 4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58 -``` - -Removes all credentials from the application with application id '4589cd6b-3d79-4bb4-93b8-a0b99f3bfc58'. - -### Example 3 - Remove all credentials using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 | Remove-AzureRmADAppCredential -``` - -Gets the application with object id '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82' and pipes that to the Remove-AzureRmADAppCredential cmdlet and removes all credentials from that application. - -## PARAMETERS - -### -ApplicationId -The id of the application to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object to remove the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: ApplicationDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete credential without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies the credential key to be removed. -The key Ids for the application can be obtained using the Get-AzureRmADAppCredential cmdlet. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithKeyIdParameterSet, ApplicationIdWithKeyIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectWithKeyIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADAppCredential](./Get-AzureRmADAppCredential.md) - -[New-AzureRmADAppCredential](./New-AzureRmADAppCredential.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADApplication.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADApplication.md deleted file mode 100644 index 45af56de79..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADApplication.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C791C593-F7D5-4961-97F9-E4909813FFE7 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadapplication -schema: 2.0.0 ---- - -# Remove-AzureRmADApplication - -## SYNOPSIS -Deletes the azure active directory application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADApplication -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Remove-AzureRmADApplication -ApplicationId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationDisplayNameParameterSet -``` -Remove-AzureRmADApplication -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADApplication -InputObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes the azure active directory application. - -## EXAMPLES - -### Example 1 - Remove application by object id - -``` -PS C:\> Remove-AzureRmADApplication -ObjectId b4cd1619-80b3-4cfb-9f8f-9f2333425738 -``` - -Removes the application with object id 'b4cd1619-80b3-4cfb-9f8f-9f2333425738' from the tenant. - -### Example 2 - Remove application by application id - -``` -PS C:\> Remove-AzureRmADApplication -ApplicationId f9c5ea4f-28f0-401a-a491-491a037fa346 -``` - -Removes the application with application id 'f9c5ea4f-28f0-401a-a491-491a037fa346' from the tenant. - -### Example 3 - Remove application by piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId b4cd1619-80b3-4cfb-9f8f-9f2333425738 | Remove-AzureRmADApplication -``` - -Gets the application with object id 'b4cd1619-80b3-4cfb-9f8f-9f2333425738' and pipes that to the Remove-AzureRmADApplication cmdlet to remove the application from the tenant. - -## PARAMETERS - -### -ApplicationId -The application id of the application to remove. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -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 - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the application. - -```yaml -Type: System.String -Parameter Sets: ApplicationDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete an application without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the application to remove. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to delete. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmADApplication](./New-AzureRmADApplication.md) - -[Get-AzureRmADApplication](./Get-AzureRmADApplication.md) - - - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroup.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroup.md deleted file mode 100644 index 3b14e85922..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroup.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadgroup -schema: 2.0.0 ---- - -# Remove-AzureRmADGroup - -## SYNOPSIS -Deletes an active directory group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADGroup -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADGroup -DisplayName <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADGroup -InputObject <PSADGroup> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an active directory group. - -## EXAMPLES - -### Example 1 - Remove a group by object id - -``` -PS C:\> Remove-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -``` - -Removes the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' from the tenant. - -### Example 2 - Remove a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE | Remove-AzureRmADGroup -``` - -Gets the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' and pipes that to Remove-AzureRmADGroup to remove the group from the tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the group to be removed. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If specified, doesn't ask for confirmation for deleting the group. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representation of the group to be removed. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the group to be removed. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroupMember.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroupMember.md deleted file mode 100644 index 93425baeae..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADGroupMember.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadgroupmember -schema: 2.0.0 ---- - -# Remove-AzureRmADGroupMember - -## SYNOPSIS -Removes a user from an AD group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ExplicitParameterSet (Default) -``` -Remove-AzureRmADGroupMember [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### MemberObjectIdWithGroupDisplayName -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObject -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberObjectIdWithGroupObjectId -``` -Remove-AzureRmADGroupMember -MemberObjectId <Guid[]> -GroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupDisplayNameParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupDisplayName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupObject <PSADGroup> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### MemberUPNWithGroupObjectIdParameterSet -``` -Remove-AzureRmADGroupMember -MemberUserPrincipalName <String[]> -GroupObjectId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Removes a user from an AD group. - -## EXAMPLES - -### Example 1 - Remove a user from a group by object id - -``` -PS C:\> Remove-AzureRmADGroup -MemberObjectId D9076BBC-D62C-4105-9C78-A7F5BC4A3405 -GroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -``` - -Removes the user with object id 'D9076BBC-D62C-4105-9C78-A7F5BC4A3405' from the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'. - -### Example 2 - Remove a user from a group by piping - -``` -PS C:\> Get-AzureRmADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE | Remove-AzureRmADGroupMember -MemberObjectId D9076BBC-D62C-4105-9C78-A7F5BC4A3405 -``` - -Gets the group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' and pipes it to the Remove-AzureRmADGroupMember cmdlet to remove the user to that group. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupDisplayName -The display name of the group to remove the member(s) from. - -```yaml -Type: System.String -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberUPNWithGroupDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupObject -The object representation of the group to remove the member from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameter Sets: MemberObjectIdWithGroupObject, MemberUPNWithGroupObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupObjectId -The object id of the group to remove the member from. - -```yaml -Type: System.Guid -Parameter Sets: MemberObjectIdWithGroupObjectId, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberObjectId -The object id of the member. - -```yaml -Type: System.Guid[] -Parameter Sets: MemberObjectIdWithGroupDisplayName, MemberObjectIdWithGroupObject, MemberObjectIdWithGroupObjectId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberUserPrincipalName -The UPN of the member(s) to remove. - -```yaml -Type: System.String[] -Parameter Sets: MemberUPNWithGroupDisplayNameParameterSet, MemberUPNWithGroupObjectParameterSet, MemberUPNWithGroupObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADGroup -Parameters: GroupObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADServicePrincipal.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADServicePrincipal.md deleted file mode 100644 index dbd5c4a488..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0C8C07CA-6720-452F-A952-48C76EBF3BBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadserviceprincipal -schema: 2.0.0 ---- - -# Remove-AzureRmADServicePrincipal - -## SYNOPSIS -Deletes the azure active directory service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdParameterSet (Default) -``` -Remove-AzureRmADServicePrincipal -ObjectId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdParameterSet -``` -Remove-AzureRmADServicePrincipal -ApplicationId <Guid> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNParameterSet -``` -Remove-AzureRmADServicePrincipal -ServicePrincipalName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADServicePrincipal -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADServicePrincipal -InputObject <PSADServicePrincipal> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationObjectParameterSet -``` -Remove-AzureRmADServicePrincipal -ApplicationObject <PSADApplication> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes the azure active directory service principal. - -## EXAMPLES - -### Example 1 - Remove a service principal by object id - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ObjectId 61b5d8ea-fdc6-40a2-8d5b-ad447c678d45 -``` - -Removes the service principal with object id '61b5d8ea-fdc6-40a2-8d5b-ad447c678d45'. - -### Example 2 - Remove a service principal by application id - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ApplicationId 9263469e-d328-4321-8646-3e3e75d20e76 -``` - -Removes the service principal with application id '9263469e-d328-4321-8646-3e3e75d20e76'. - -### Example 3 - Remove a service principal by SPN - -``` -PS C:\> Remove-AzureRmADServicePrincipal -ServicePrincipalName MyServicePrincipal -``` - -Remove the service principal with service principal name "MyServicePrincipal" - -### Example 4 - Remove a service principal by piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 61b5d8ea-fdc6-40a2-8d5b-ad447c678d45 | Remove-AzureRmADServicePrincipal -``` - -Gets the service principal with object id '61b5d8ea-fdc6-40a2-8d5b-ad447c678d45' and pipes that to the Remove-AzureRmADServicePrincipal cmdlet to remove that service principal. - -### Example 5 - Remove a service principal by piping an application - -``` -PS C:\> Get-AzureRmApplication -ApplicationId 9263469e-d328-4321-8646-3e3e75d20e76 | Remove-AzureRmADServicePrincipal -``` - -Gets the application with application id '9263469e-d328-4321-8646-3e3e75d20e76' and pipes that to the Remove-AzureRmADServicePrincipal cmdlet to remove the service principal associated with that application. - -## PARAMETERS - -### -ApplicationId -The service principal application id. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationObject -The application object whose service principal is being removed. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: ApplicationObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete service principal without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The service principal object. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to delete. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: PrincipalId, Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified, returns the deleted service principal. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The service principal name. - -```yaml -Type: System.String -Parameter Sets: SPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: InputObject (ByValue) - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: ApplicationObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmADServicePrincipal](./New-AzureRmADServicePrincipal.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - - - -[Remove-AzureRmADApplication](./Remove-AzureRmADApplication.md) - -[Remove-AzureRmADAppCredential](./Remove-AzureRmADAppCredential.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADSpCredential.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADSpCredential.md deleted file mode 100644 index e6a906e004..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADSpCredential.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 04B1E3A6-6D52-46A3-8241-2CCDB5E71642 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermadspcredential -schema: 2.0.0 ---- - -# Remove-AzureRmADSpCredential - -## SYNOPSIS -Removes a credential from a service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ObjectIdWithKeyIdParameterSet (Default) -``` -Remove-AzureRmADSpCredential -ObjectId <Guid> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithKeyIdParameterSet -``` -Remove-AzureRmADSpCredential -ServicePrincipalName <String> [-KeyId <Guid>] [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### DisplayNameWithKeyIdParameterSet -``` -Remove-AzureRmADSpCredential -DisplayName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ServicePrincipalObjectParameterSet -``` -Remove-AzureRmADSpCredential -ServicePrincipalObject <PSADServicePrincipal> [-KeyId <Guid>] [-PassThru] - [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmADSpCredential cmdlet can be used to remove a credential key from a service principal in the case of a compromise or as part of credential key rollover expiration. -The service principal is identified by supplying either the object ID or service principal name (SPN). -The credential to be removed is identified by its key ID if an individual credential is to be removed or with an 'All' switch to delete all credentials associated with the service principal. - -## EXAMPLES - -### Example 1 - Remove a specific credential from a service principal - -``` -PS C:\> Remove-AzureRmADSpCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb -``` - -Removes the credential with key id '9044423a-60a3-45ac-9ab1-09534157ebb' from the service principal with object id '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82'. - -### Example 2 - Remove all credentials from a service principal - -``` -PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123 -``` - -Removes all credentials from the service principal with the SPN "http://test123". - -### Example 3 - Remove all credentials from a service principal using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 | Remove-AzureRmADSpCredential -``` - -Gets the service principal with object id '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82' and pipes that to the Remove-AzureRmADSpCredential cmdlet to remove all credentials from that service principal. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the service principal. - -```yaml -Type: System.String -Parameter Sets: DisplayNameWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Switch to delete credential without a confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies the credential key to be removed. -The key Ids for a service principal can be obtained using the Get-AzureRmADSpCredential cmdlet. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdWithKeyIdParameterSet, SPNWithKeyIdParameterSet, ServicePrincipalObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to remove the credentials from. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The name (SPN) of the service principal to remove the credentials from. - -```yaml -Type: System.String -Parameter Sets: SPNWithKeyIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalObject -The service principal object to remove the credentials from. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: ServicePrincipalObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: ServicePrincipalObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmADSpCredential](./Get-AzureRmADSpCredential.md) - -[New-AzureRmADSpCredential](./New-AzureRmADSpCredential.md) - -[Get-AzureRmADServicePrincipal](./Get-AzureRmADServicePrincipal.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADUser.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADUser.md deleted file mode 100644 index f25bc8aa59..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmADUser.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 9F9B2691-BB3F-4644-BD95-6D74777D1E99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermaduser -schema: 2.0.0 ---- - -# Remove-AzureRmADUser - -## SYNOPSIS -Deletes an active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UPNOrObjectIdParameterSet (Default) -``` -Remove-AzureRmADUser -UPNOrObjectId <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Remove-AzureRmADUser -UserPrincipalName <String> [-PassThru] [-Force] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Remove-AzureRmADUser -ObjectId <Guid> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### DisplayNameParameterSet -``` -Remove-AzureRmADUser -DisplayName <String> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmADUser -InputObject <PSADUser> [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Deletes an active directory user (work/school account also popularly known as org-id). - -## EXAMPLES - -### Example 1 - Remove a user by user principal name - -``` -PS C:\> Remove-AzureRmADUser -UserPrincipalName foo@domain.com -``` - -Removes the user with user principal name "foo@domain.com" from the tenant. - -### Example 2 - Remove a user by object id - -``` -PS C:\> Remove-AzureRmADUser -ObjectId 7a9582cf-88c4-4319-842b-7a5d60967a69 -``` - -Removes the user with object id '7a9582cf-88c4-4319-842b-7a5d60967a69' from the tenant. - -### Example 3 - Remove a user by piping - -``` -PS C:\> Get-AzureRmADUser -ObjectId 7a9582cf-88c4-4319-842b-7a5d60967a69 | Remove-AzureRmADUser -``` - -Gets the user with object id '7a9582cf-88c4-4319-842b-7a5d60967a69' and pipes that to the Remove-AzureRmADUser cmdlet to remove the user from the tenant. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: DisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -If specified, doesn't ask for confirmation for deleting the user. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The user object to be deleted. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the user to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Specifying this will return true if the command was successful. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UPNOrObjectId -The user principal name or the objectId of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name of the user to be deleted. - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[New-AzureRmADUser](./New-AzureRmADUser.md) - -[Get-AzureRmADUser](./Get-AzureRmADUser.md) - - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmDeployment.md deleted file mode 100644 index aef1ae24be..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmDeployment.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermdeployment -schema: 2.0.0 ---- - -# Remove-AzureRmDeployment - -## SYNOPSIS -Removes a deployment and any associated operations - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByDeploymentName (Default) -``` -Remove-AzureRmDeployment [-Name] <String> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByDeploymentId -``` -Remove-AzureRmDeployment -Id <String> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByInputObject -``` -Remove-AzureRmDeployment -InputObject <PSDeployment> [-AsJob] [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmDeployment** cmdlet removes an Azure deployment at subscription scope and any associated operations. - -## EXAMPLES - -### Example 1: Remove a deployment with a given name -``` -PS C:\>Remove-AzureRmDeployment -Name "RolesDeployment" -``` - -This command removes the deployment "RolesDeployment" at the current subscription scope. - -### Example 2: Get a deployment and remove it -``` -PS C:\>Get-AzureRmDeployment -Name "RolesDeployment" | Remove-AzureRmDeployment -``` - -This command gets the deployment "RolesDeployment" at the current subscription scope and removes it. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: 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 resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: RemoveByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: RemoveByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the deployment. - -```yaml -Type: String -Parameter Sets: RemoveByDeploymentName -Aliases: DeploymentName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplication.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplication.md deleted file mode 100644 index dd43e32628..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplication.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagedapplication -schema: 2.0.0 ---- - -# Remove-AzureRmManagedApplication - -## SYNOPSIS -Removes a managed application - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup (Default) -``` -Remove-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveById -``` -Remove-AzureRmManagedApplication -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagedApplication** cmdlet removes a managed application - -## EXAMPLES - -### Example 1: Remove managed application by resource ID -``` -PS C:\>$Application = Get-AzureRmManagedApplication -Name "myApp" -ResourceGroupName "myRG" -PS C:\>Remove-AzureRmManagedApplication -Id $Application.ResourceId -Force -``` - -The first command gets a managed application named myApp by using the Get-AzureRmManagedApplication cmdlet. -The command stores it in the $Application variable. - -The second command removes the managed application identified by the **ResourceId** property of $Application. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: RemoveById -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The managed application name. - -```yaml -Type: String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplicationDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index c8a5bc850d..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermmanagedapplicationdefinition -schema: 2.0.0 ---- - -# Remove-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Removes a managed application definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByNameAndResourceGroup (Default) -``` -Remove-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### RemoveById -``` -Remove-AzureRmManagedApplicationDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmManagedApplicationDefinition** cmdlet removes a managed application definition - -## EXAMPLES - -### Example 1: Remove managed application definition by resource ID -``` -PS C:\>$ApplicationDefinition = Get-AzureRmManagedApplicationDefinition -Name "myAppDef" -ResourceGroupName "myRG" -PS C:\>Remove-AzureRmManagedApplicationDefinition -Id $ApplicationDefinition.ResourceId -Force -``` - -The first command gets a managed application definition named myAppDef by using the Get-AzureRmManagedApplicationDefinition cmdlet. -The command stores it in the $ApplicationDefinition variable. - -The second command removes the managed application definition identified by the **ResourceId** property of $ApplicationDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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: RemoveById -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: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: RemoveByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyAssignment.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyAssignment.md deleted file mode 100644 index 535d6f1e64..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 36399302-3EA5-45A3-A042-536CC7EC2E6D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicyassignment -schema: 2.0.0 ---- - -# Remove-AzureRmPolicyAssignment - -## SYNOPSIS -Removes a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicyAssignment -Name <String> -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicyAssignment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicyAssignment** cmdlet removes the specified policy assignment. - -## EXAMPLES - -### Example 1: Remove policy assignment by name and scope -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> Remove-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -Force -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command removes the policy assignment named PolicyAssignment07 that was assigned at a resource group level. -The **ResourceId** property of $ResourceGroup identifies the resource group. - -### Example 2: Remove policy assignment by ID -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceId -PS C:\> Remove-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -Force -``` - -The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable. -The second command gets the policy assignment at a resource group level, and then stores it in the $PolicyAssignment variable. -The **ResourceId** property of $ResourceGroup identifies the resource group. -The final command removes the policy assignment that the **ResourceId** property of $PolicyAssignment identifies. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy assignment that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Set-AzureRmPolicyAssignment](./Set-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyDefinition.md deleted file mode 100644 index 26953fda38..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: DEC01722-EB1A-45CE-BD30-9DB861718573 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicydefinition -schema: 2.0.0 ---- - -# Remove-AzureRmPolicyDefinition - -## SYNOPSIS -Removes a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] -ManagementGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Remove-AzureRmPolicyDefinition -Name <String> [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicyDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicyDefinition** cmdlet removes a policy definition. - -## EXAMPLES - -### Example 1: Remove the policy definition by name -``` -PS C:\> Remove-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -``` - -This command removes the specified policy definition. - -### Example 2: Remove policy definition by resource ID -``` -PS C:\> $PolicyDefinition = Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -PS C:\> Remove-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Force -``` - -The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores it in the $PolicyDefinition variable. -The second command removes the policy definition identified by the **ResourceId** property of $PolicyDefinition. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy definition that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition to delete. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -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 removes. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition to delete. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Set-AzureRmPolicyDefinition](./Set-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicySetDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicySetDefinition.md deleted file mode 100644 index 388e44e5ba..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermpolicysetdefinition -schema: 2.0.0 ---- - -# Remove-AzureRmPolicySetDefinition - -## SYNOPSIS -Removes a policy set definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Remove-AzureRmPolicySetDefinition -Name <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Remove-AzureRmPolicySetDefinition [-Name <String>] [-Force] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Remove-AzureRmPolicySetDefinition [-Name <String>] [-Force] -SubscriptionId <Guid> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### IdParameterSet -``` -Remove-AzureRmPolicySetDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmPolicySetDefinition** cmdlet removes a policy definition. - -## EXAMPLES - -### Example 1: Remove policy set definition by resource ID -``` -PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' -PS C:\> Remove-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Force -``` - -The first command gets a policy set definition by using the Get-AzureRmPolicySetDefinition cmdlet. -The command stores it in the $PolicySetDefinition variable. -The second command removes the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The fully qualified policy set definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition to delete. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -The policy set definition name. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition to delete. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResource.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResource.md deleted file mode 100644 index c509c372d5..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResource.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: A262DFD1-8B90-462C-A4E2-ABA0F51173FA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresource -schema: 2.0.0 ---- - -# Remove-AzureRmResource - -## SYNOPSIS -Removes a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Remove-AzureRmResource [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Remove-AzureRmResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] - [-ExtensionResourceType <String>] [-ODataQuery <String>] [-ResourceGroupName <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByTenantLevel -``` -Remove-AzureRmResource [-AsJob] -ResourceName <String> -ResourceType <String> [-ExtensionResourceName <String>] - [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResource** cmdlet removes an Azure resource. - -## EXAMPLES - -### Example 1: Remove a website resource -``` -PS C:\>Remove-AzureRmResource -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup11/providers/Microsoft.Web/sites/ContosoSite" -Force -``` - -This command removes the website resource named ContosoSite. -The example uses a placeholder value for the subscription ID. -The command specifies the *Force* parameter. -Therefore, it does not prompt you for confirmation. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -Specifies the extension resource type for the resource. -For instance: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group from which this cmdlet removes a resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID of the resource that this cmdlet removes. -The ID includes the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource that this cmdlet removes. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource that this cmdlet removes. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Set-AzureRmResource](./Set-AzureRmResource.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroup.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroup.md deleted file mode 100644 index 072c12a380..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroup.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 880D321E-30F2-4CAE-B14A-5F6DD8E1DB99 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcegroup -schema: 2.0.0 ---- - -# Remove-AzureRmResourceGroup - -## SYNOPSIS -Removes a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByResourceGroupName (Default) -``` -Remove-AzureRmResourceGroup [-Name] <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceGroupId -``` -Remove-AzureRmResourceGroup [-Id] <String> [-Force] [-AsJob] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceGroup** cmdlet removes an Azure resource group and its resources from the current subscription. -To delete a resource, but leave the resource group, use the Remove-AzureRmResource cmdlet. - -## EXAMPLES - -### Example 1: Remove a resource group -``` -PS C:\>Remove-AzureRmResourceGroup -Name "ContosoRG01" -``` - -This command removes the ContosoRG01 resource group from the subscription. -The cmdlet prompts you for confirmation and returns no output. - -### Example 2: Remove a resource group without confirmation -``` -PS C:\>Get-AzureRmResourceGroup -Name "ContosoRG01" | Remove-AzureRmResourceGroup -Verbose -Force -``` - -This command uses the Get-AzureRmResourceGroup cmdlet to get the resource group ContosoRG01, and then passes it to **Remove-AzureRmResourceGroup** by using the pipeline operator. -The *Verbose* common parameter gets status information about the operation, and the *Force* parameter suppresses the confirmation prompt. - -### Example 3: Remove all resource groups -``` -PS C:\>Get-AzureRmResourceGroup | Remove-AzureRmResourceGroup -``` - -This command uses the **Get-AzureRmResourceGroup** cmdlet to get all resource groups, and then passes them to **Remove-AzureRmResourceGroup** by using the pipeline operator. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the ID of resource group to remove. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the names of resource groups to remove. -Wildcard characters are not permitted. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: ResourceGroupName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Set-AzureRmResourceGroup](./Set-AzureRmResourceGroup.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroupDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroupDeployment.md deleted file mode 100644 index d5be51a829..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C3DD193E-B8FE-468D-BEE7-00C3D99B469E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcegroupdeployment -schema: 2.0.0 ---- - -# Remove-AzureRmResourceGroupDeployment - -## SYNOPSIS -Removes a resource group deployment and any associated operations. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RemoveByResourceGroupName (Default) -``` -Remove-AzureRmResourceGroupDeployment -ResourceGroupName <String> -Name <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RemoveByResourceGroupDeploymentId -``` -Remove-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceGroupDeployment** cmdlet removes an Azure resource group deployment and any associated operations. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: DeploymentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to remove. - -```yaml -Type: System.String -Parameter Sets: RemoveByResourceGroupName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceLock.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceLock.md deleted file mode 100644 index 9cafeca02c..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmResourceLock.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 42EEAAA8-F13B-486B-82BD-F646EF0DCDBA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermresourcelock -schema: 2.0.0 ---- - -# Remove-AzureRmResourceLock - -## SYNOPSIS -Removes a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByLockId (Default) -``` -Remove-AzureRmResourceLock [-Force] -LockId <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceGroup -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceGroupName <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySpecifiedScope -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -Scope <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByTenantLevel -``` -Remove-AzureRmResourceLock -LockName <String> [-Force] -ResourceName <String> -ResourceType <String> - [-TenantLevel] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmResourceLock** cmdlet removes an Azure resource lock. - -## EXAMPLES - -### Example 1: Remove a lock -``` -PS C:\>Remove-AzureRmResourceLock -LockName "ContosoSiteLock" -ResourceName "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/mystorageaccount/providers/Microsoft.Authorization/locks/test" -``` - -This command removes the lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet removes. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel, BySpecifiedScope, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -Server`/`Database - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type of the resource for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Set-AzureRmResourceLock](./Set-AzureRmResourceLock.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleAssignment.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleAssignment.md deleted file mode 100644 index ab6e8e31bf..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleAssignment.md +++ /dev/null @@ -1,401 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8C1D738C-825D-4718-AD2A-9CFEAA7DBD3B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermroleassignment -schema: 2.0.0 ---- - -# Remove-AzureRmRoleAssignment - -## SYNOPSIS -Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### EmptyParameterSet (Default) -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ScopeWithObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleIdWithScopeAndObjectIdParameterSet -``` -Remove-AzureRmRoleAssignment -ObjectId <Guid> [-Scope <String>] -RoleDefinitionId <Guid> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> -ResourceGroupName <String> -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ScopeWithSignInNameParameterSet -``` -Remove-AzureRmRoleAssignment -SignInName <String> [-Scope <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> -ResourceName <String> - -ResourceType <String> [-ParentResource <String>] -RoleDefinitionName <String> [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ResourceGroupWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> -ResourceGroupName <String> - -RoleDefinitionName <String> [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ScopeWithSPNParameterSet -``` -Remove-AzureRmRoleAssignment -ServicePrincipalName <String> [-Scope <String>] -RoleDefinitionName <String> - [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleAssignmentParameterSet -``` -Remove-AzureRmRoleAssignment [-PassThru] [-InputObject] <PSRoleAssignment> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Use the Remove-AzureRmRoleAssignment commandlet to revoke access to any principal at given scope and given role. -The object of the assignment i.e. -the principal MUST be specified. -The principal can be a user (use SignInName or ObjectId parameters to identify a user), security group (use ObjectId parameter to identify a group) or service principal (use ServicePrincipalName or ObjectId parameters to identify a ServicePrincipal. -The role that the principal is assigned to MUST be specified using the RoleDefinitionName parameter. -The scope of the assignment MAY be specified and if not specified, defaults to the subscription scope i.e. -it will try to delete an assignment to the specified principal and role at the subscription scope. -The scope of the assignment can be specified using one of the following parameters. - a. -Scope - This is the fully qualified scope starting with /subscriptions/\<subscriptionId\> - b. -ResourceGroupName - Name of any resource group under the subscription. - c. -ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Remove-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader -``` - -Removes a role assignment for john.doe@contoso.com who is assigned to the Reader role at the rg1 resourcegroup scope. - -### Example 2 -``` -PS C:\> Remove-AzureRmRoleAssignment -ObjectId 36f81fc3-b00f-48cd-8218-3879f51ff39f -RoleDefinitionName Reader -``` - -Removes the role assignment to the group principal identified by the ObjectId and assigned to the Reader role. -Defaults to using the current subscription as the scope to find the assignment to be deleted. - -### Example 3 -``` -PS C:\> $roleassignment = Get-AzureRmRoleAssignment |Select-Object -First 1 -Wait -PS C:\> Remove-AzureRmRoleAssignment -InputObject $roleassignment -``` - -Removes the first role assignment object which is fetched from the Get-AzureRmRoleAssignment commandlet. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: Microsoft.Azure.Commands.Resources.Models.Authorization.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. - -```yaml -Type: System.Guid -Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet -Aliases: Id, PrincipalId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentResource -The parent resource in the hierarchy(of the resource specified using ResourceName parameter), if any. -Must be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -If specified, displays the deleted role assignment - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name that the role is assigned to. -Attempts to delete an assignment at the specified resource group scope. -When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -The resource name. -For e.g. -storageaccountprod. -Must be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters, to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that scope. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -The resource type. -For e.g. -Microsoft.Network/virtualNetworks. -Must be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that resource scope. - -```yaml -Type: System.String -Parameter Sets: ResourceWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionId -Id of the RBAC role for which the assignment needs to be deleted. - -```yaml -Type: System.Guid -Parameter Sets: RoleIdWithScopeAndObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RoleDefinitionName -Name of the RBAC role for which the assignment needs to be deleted i.e. -Reader, Contributor, Virtual Network Administrator, etc. - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ResourceWithObjectIdParameterSet, ResourceGroupWithObjectIdParameterSet, ScopeWithObjectIdParameterSet, ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet, ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -The Scope of the role assignment to be deleted. -In the format of relative URI. -For e.g. -"/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". -If not specified, will attempt to delete the role at subscription level. -If specified, it should start with "/subscriptions/{id}". - -```yaml -Type: System.String -Parameter Sets: EmptyParameterSet, ScopeWithObjectIdParameterSet, RoleIdWithScopeAndObjectIdParameterSet, ScopeWithSignInNameParameterSet, ScopeWithSPNParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The ServicePrincipalName of the Azure AD application - -```yaml -Type: System.String -Parameter Sets: ResourceWithSPNParameterSet, ResourceGroupWithSPNParameterSet, ScopeWithSPNParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignInName -The email address or the user principal name of the user. - -```yaml -Type: System.String -Parameter Sets: ResourceWithSignInNameParameterSet, ResourceGroupWithSignInNameParameterSet, ScopeWithSignInNameParameterSet -Aliases: Email, UserPrincipalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleAssignment - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleAssignment](./New-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleAssignment](./Get-AzureRmRoleAssignment.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleDefinition.md deleted file mode 100644 index 479dfc6a1d..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Remove-AzureRmRoleDefinition.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 2D882B33-2B62-4785-AF8F-5F4644E9504D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/remove-azurermroledefinition -schema: 2.0.0 ---- - -# Remove-AzureRmRoleDefinition - -## SYNOPSIS -Deletes a custom role in Azure RBAC. -The role to be deleted is specified using the Id property of the role. -Delete will fail if there are existing role assignments made to the custom role. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### RoleDefinitionIdParameterSet (Default) -``` -Remove-AzureRmRoleDefinition -Id <Guid> [-Scope <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### RoleDefinitionNameParameterSet -``` -Remove-AzureRmRoleDefinition [-Name] <String> [-Scope <String>] [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Remove-AzureRmRoleDefinition -InputObject <PSRoleDefinition> [-Force] [-PassThru] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The Remove-AzureRmRoleDefinition cmdlet deletes a custom role in Azure Role-Based Access Control. - Provide the Id parameter of an existing custom role to delete that custom role. -By default, Remove-AzureRmRoleDefinition prompts you for confirmation. -To suppress the prompt, use the Force parameter. -If there are existing role assignments made to the custom role to be deleted, the delete will fail. - -## EXAMPLES - -### Example 1 -``` -Get-AzureRmRoleDefinition -Name "Virtual Machine Operator" | Remove-AzureRmRoleDefinition -``` - -### Example 2 -``` -Remove-AzureRmRoleDefinition -Id "52a6cc13-ff92-47a8-a39b-2a8205c3087e" -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Id of the Role definition to be deleted - -```yaml -Type: System.Guid -Parameter Sets: RoleDefinitionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The object representing the role definition to be removed. - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Role definition to be deleted. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionNameParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Role definition scope. - -```yaml -Type: System.String -Parameter Sets: RoleDefinitionIdParameterSet, RoleDefinitionNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameters: InputObject (ByValue) - -## OUTPUTS - -### System.Boolean - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[Set-AzureRmRoleDefinition](./Set-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmDeploymentTemplate.md b/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmDeploymentTemplate.md deleted file mode 100644 index d4df0ae39a..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmDeploymentTemplate.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/save-azurermdeploymenttemplate -schema: 2.0.0 ---- - -# Save-AzureRmDeploymentTemplate - -## SYNOPSIS -Saves a deployment template to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SaveByDeploymentName (Default) -``` -Save-AzureRmDeploymentTemplate -DeploymentName <String> [-Path <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SaveByDeploymentObject -``` -Save-AzureRmDeploymentTemplate -DeploymentObject <PSDeployment> [-Path <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmDeploymentTemplate** cmdlet saves a deployment template to a JSON file. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Save-AzureRmDeploymentTemplate -DeploymentName "TestDeployment" -``` - -This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. - -### Example 2: Get a deployment and save its template -``` -PS C:\>Get-AzureRmDeployment -Name "RolesDeployment" | Save-AzureRmDeploymentTemplate -``` - -This command gets the deployment "RolesDeployment" at the current subscription scope and saves its template. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: 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. - -```yaml -Type: String -Parameter Sets: SaveByDeploymentName -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: SaveByDeploymentObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Do not ask for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The output path of the template file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md b/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md deleted file mode 100644 index 99960d4a71..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Save-AzureRmResourceGroupDeploymentTemplate.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 8BB4AD6B-EBE3-442A-83E7-B77A31573208 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/save-azurermresourcegroupdeploymenttemplate -schema: 2.0.0 ---- - -# Save-AzureRmResourceGroupDeploymentTemplate - -## SYNOPSIS -Saves a resource group deployment template to a file. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Save-AzureRmResourceGroupDeploymentTemplate -ResourceGroupName <String> -DeploymentName <String> - [-Path <String>] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Save-AzureRmResourceGroupDeploymentTemplate** cmdlet saves a resource group deployment template to a JSON file. - -## EXAMPLES - -### Example 1: Save a deployment template -``` -PS C:\>Save-AzureRmResourceGroupDeploymentTemplate -DeploymentName "TestDeployment" -ResourceGroupName "TestGroup" -``` - -This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If not specified, the latest API version is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the output path of the template file. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: ResourceGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplication.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplication.md deleted file mode 100644 index 4081e31ecc..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplication.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermmanagedapplication -schema: 2.0.0 ---- - -# Set-AzureRmManagedApplication - -## SYNOPSIS -Updates managed application - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup (Default) -``` -Set-AzureRmManagedApplication -Name <String> -ResourceGroupName <String> [-ManagedResourceGroupName <String>] - [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] - [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### SetById -``` -Set-AzureRmManagedApplication -Id <String> [-ManagedResourceGroupName <String>] - [-ManagedApplicationDefinitionId <String>] [-Parameter <String>] [-Kind <String>] [-Plan <Hashtable>] - [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmManagedApplication** cmdlet updates managed applications - -## EXAMPLES - -### Example 1: Update managed application definition description -``` -PS C:\>Set-AzureRmManagedApplication -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applications/myApp" -Description "Updated description here" -``` - -This command updates the managed application description - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: 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 managed application Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName - -```yaml -Type: String -Parameter Sets: SetById -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 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedApplicationDefinitionId -The managed resource group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedResourceGroupName -The managed resource group name. - -```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 name. - -```yaml -Type: String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The JSON formatted string of parameters for managed application. -This can either be a path to a file name or uri containing the parameters, or the parameters 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 -``` - -### -Plan -A hash table which represents managed application plan properties. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -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. - -```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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -System.Collections.Hashtable - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplicationDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplicationDefinition.md deleted file mode 100644 index abed69b4bb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmManagedApplicationDefinition.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermmanagedapplicationdefinition -schema: 2.0.0 ---- - -# Set-AzureRmManagedApplicationDefinition - -## SYNOPSIS -Updates managed application definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByNameAndResourceGroup (Default) -``` -Set-AzureRmManagedApplicationDefinition -Name <String> -ResourceGroupName <String> [-DisplayName <String>] - [-Description <String>] [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SetById -``` -Set-AzureRmManagedApplicationDefinition -Id <String> [-DisplayName <String>] [-Description <String>] - [-PackageFileUri <String>] [-Authorization <String[]>] [-Tag <Hashtable>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmManagedApplicationDefinition** cmdlet updates managed application definitions - -## EXAMPLES - -### Example 1: Update managed application definition description -``` -PS C:\>Set-AzureRmManagedApplicationDefinition -ResourceId "/subscriptions/mySubId/resourcegroups/myRG/Microsoft.Solutions/applicationDefinitions/myAppDef" -Description "Updated description here" -``` - -This command updates the managed application definition description - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authorization -The managed application definition authorization. -Comma separated authorization pairs in a format of \<principalId\>:\<roleDefinitionId\> - -```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. - -```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 managed application definition description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The managed application definition display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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: SetById -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: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageFileUri -The managed application definition package file uri. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The resource group name. - -```yaml -Type: String -Parameter Sets: SetByNameAndResourceGroup -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -A hash table which represents resource tags. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -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. - -```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 (https://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/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyAssignment.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyAssignment.md deleted file mode 100644 index 81644dc338..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyAssignment.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: C3B2C33F-8BD4-4E31-9450-EF6A3A6A5325 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicyassignment -schema: 2.0.0 ---- - -# Set-AzureRmPolicyAssignment - -## SYNOPSIS -Modifies a policy assignment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicyAssignment -Name <String> -Scope <String> [-NotScope <String[]>] [-DisplayName <String>] - [-Description <String>] [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>] - [-Metadata <String>] [-Sku <Hashtable>] [-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicyAssignment** cmdlet modifies a policy assignment. -Specify an assignment by ID or by name and scope. - -## EXAMPLES - -### Example 1: Update the display name -``` -PS C:\> $ResourceGroup = Get-AzureRmResourceGroup -Name 'ResourceGroup11' -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment' -Scope $ResourceGroup.ResourceId -PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName 'Do not allow VM creation' -``` - -The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. -The command stores that object in the $ResourceGroup variable. -The second command gets the policy assignment named PolicyAssignment by using the Get-AzureRmPolicyAssignment cmdlet. -The command stores that object in the $PolicyAssignment variable. -The final command updates the display name on the policy assignment on the resource group identified by the **ResourceId** property of $ResourceGroup. - -### Example 2: Add a managed identity to the policy assignment -``` -PS C:\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name 'PolicyAssignment' -PS C:\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -AssignIdentity -Location 'westus' -``` - -The first command gets the policy assignment named PolicyAssignment from the current subscription by using the Get-AzureRmPolicyAssignment cmdlet. -The command stores that object in the $PolicyAssignment variable. -The final command assigns a managed identity to the policy assignment. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: System.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy assignment that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The updated metadata for the policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.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 assignment that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotScope -The policy assignment not scopes. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the policy is applied. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -A hash table which represents sku properties. - -```yaml -Type: System.Collections.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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyAssignment](./Get-AzureRmPolicyAssignment.md) - -[New-AzureRmPolicyAssignment](./New-AzureRmPolicyAssignment.md) - -[Remove-AzureRmPolicyAssignment](./Remove-AzureRmPolicyAssignment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyDefinition.md deleted file mode 100644 index c11c92e2b1..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicyDefinition.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: E1AC7139-786C-4DD6-A898-242723E0D159 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicydefinition -schema: 2.0.0 ---- - -# Set-AzureRmPolicyDefinition - -## SYNOPSIS -Modifies a policy definition. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Set-AzureRmPolicyDefinition -Name <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicyDefinition -Id <String> [-DisplayName <String>] [-Description <String>] [-Policy <String>] - [-Metadata <String>] [-Parameter <String>] [-Mode <PolicyDefinitionMode>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicyDefinition** cmdlet modifies a policy definition. - -## EXAMPLES - -### Example 1: Update the description of a policy definition -``` -PS C:\> $PolicyDefinition = Get-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -PS C:\> Set-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' -``` - -The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. -The command stores that object in the $PolicyDefinition variable. -The second command updates the description of the policy definition identified by the **ResourceId** property of $PolicyDefinition. - -### Example 2: Update the mode of a policy definition -``` -PS C:\> Set-AzureRmPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All' -``` - -This command updates the policy definition named VMPolicyDefinition by using the Set-AzureRmPolicyDefinition cmdlet to -set its mode property to 'All'. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.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 definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Specifies the fully qualified resource ID for the policy definition that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy definition to update. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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: System.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 new policy definition. - -```yaml -Type: System.Nullable`1[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyDefinitionMode] -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. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -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: System.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy definition to update. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmPolicyDefinition](./Get-AzureRmPolicyDefinition.md) - -[New-AzureRmPolicyDefinition](./New-AzureRmPolicyDefinition.md) - -[Remove-AzureRmPolicyDefinition](./Remove-AzureRmPolicyDefinition.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicySetDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicySetDefinition.md deleted file mode 100644 index c716e11bcb..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmPolicySetDefinition.md +++ /dev/null @@ -1,292 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermpolicysetdefinition -schema: 2.0.0 ---- - -# Set-AzureRmPolicySetDefinition - -## SYNOPSIS -Modifies a policy set definition - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NameParameterSet (Default) -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ManagementGroupNameParameterSet -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -ManagementGroupName <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### SubscriptionIdParameterSet -``` -Set-AzureRmPolicySetDefinition -Name <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] -SubscriptionId <Guid> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IdParameterSet -``` -Set-AzureRmPolicySetDefinition -Id <String> [-DisplayName <String>] [-Description <String>] - [-PolicyDefinition <String>] [-Metadata <String>] [-Parameter <String>] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmPolicySetDefinition** cmdlet modifies a policy definition. - -## EXAMPLES - -### Example 1: Update the description of a policy set definition -``` -PS C:\> $PolicySetDefinition = Get-AzureRmPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition' -PS C:\> Set-AzureRmPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation' -``` - -The first command gets a policy set definition by using the Get-AzureRmPolicySetDefinition cmdlet. -The command stores that object in the $PolicySetDefinition variable. -The second command updates the description of the policy set definition identified by the **ResourceId** property of $PolicySetDefinition. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -The display name for policy set definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -The fully qualified policy definition Id, including the subscription. -e.g. -/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName} - -```yaml -Type: System.String -Parameter Sets: IdParameterSet -Aliases: ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagementGroupName -The name of the management group of the policy set definition to update. - -```yaml -Type: System.String -Parameter Sets: ManagementGroupNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Metadata -The metadata of the updated policy set definition. This can either be a path to a file name containing the metadata, or the metadata as a string. - -```yaml -Type: System.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. - -```yaml -Type: System.String -Parameter Sets: NameParameterSet, ManagementGroupNameParameterSet, SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameter -The parameters declaration of the updated policy set definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as a string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyDefinition -The policy set definition. This can either be a path to a file name containing the policy definitions, or the policy set definition as string. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription ID of the policy set definition to update. - -```yaml -Type: System.Nullable`1[System.Guid] -Parameter Sets: SubscriptionIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -## OUTPUTS - -### System.Management.Automation.PSObject - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResource.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResource.md deleted file mode 100644 index 95cb3b24fa..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResource.md +++ /dev/null @@ -1,471 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: A00160B9-831F-4A20-8D9D-9E89BC4F5C91 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresource -schema: 2.0.0 ---- - -# Set-AzureRmResource - -## SYNOPSIS -Modifies a resource. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByResourceId (Default) -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceId <String> [-ODataQuery <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByInputObject -``` -Set-AzureRmResource -InputObject <PSResource> [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] - [-Sku <Hashtable>] [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] [-ODataQuery <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] - [-ResourceGroupName <String>] [-Force] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Set-AzureRmResource [-Kind <String>] [-Properties <PSObject>] [-Plan <Hashtable>] [-Sku <Hashtable>] - [-Tag <Hashtable>] [-UsePatchSemantics] [-AsJob] -ResourceName <String> -ResourceType <String> - [-ExtensionResourceName <String>] [-ExtensionResourceType <String>] [-ODataQuery <String>] [-TenantLevel] - [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResource** cmdlet modifies an existing Azure resource. -Specify a resource to modify by name and type or by ID. - -## EXAMPLES - -### Example 1: Modify a resource -``` -PS C:\> $Resource = Get-AzureRmResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite -PS C:\> $Resource.Properties.Enabled = "False" -PS C:\> $Resource | Set-AzureRmResource -Force -``` - -The first command gets the resource named ContosoSite by using the Get-AzureRmResource cmdlet, and then stores it in the $Resource variable. -The second command modifies a property of $Resource. -The final command updates the resource to match $Resource. - -### Example 2: Modify all resources in a given resource group -``` -PS C:\> $Resource = Get-AzureRmResource -ResourceGroupName testrg -PS C:\> $Resource | ForEach-Object { $_.Tags.Add("testkey", "testval") } -PS C:\> $Resource | Set-AzureRmResource -Force - -Name : kv-test -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/kv-test -ResourceName : kv-test -ResourceType : Microsoft.KeyVault/vaults -ResourceGroupName : testrg -Location : westus -SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tags : {testrgkey, key} -Properties : @{} - -Name : testresource -ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Providers.Test/statefulResources/testresource -ResourceName : testresource -ResourceType : Providers.Test/statefulResources -ResourceGroupName : testrg -Location : West US 2 -SubscriptionId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Tags : {testrgkey, anothertesttag} -Properties : @{key=value} -Sku : @{name=A0} -``` - -The first command gets the resources in the testrg resource group, and then stores them in the $Resource variable. - -The second command iterates over each of these resources in the resource group and adds a new tag to them. - -The final command updates each of these resources. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. -For instance, to specify a database, use the following format: -server name`/`database name - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExtensionResourceType -Specifies the resource type for an extension resource. -For instance, if the extension resource is a database specify the following: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representation of the resource to update. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResource -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Kind -Specifies the resource kind for the resource. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ODataQuery -Specifies an Open Data Protocol (OData) style filter. -This cmdlet appends this value to the request in addition to any other filters. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Plan -Specifies resource plan properties, as a hash table, for the resource. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: PlanObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies resource properties for the resource. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: PropertyObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group where this cmdlet modifies the resource. - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -Specifies the fully qualified resource ID, including the subscription, as in the following example: -`/subscriptions/`subscription ID`/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: ByResourceId -Aliases: Id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource. -For instance, to specify a database, use the following format: -`ContosoServer/ContosoDatabase` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the type of the resource. -For instance, for a database, the resource type is as follows: -`Microsoft.Sql/Servers/Databases` - -```yaml -Type: System.String -Parameter Sets: BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Sku -Specifies the SKU object of the resource as a hash table. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: SkuObject - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePatchSemantics -Indicates that this cmdlet uses an HTTP PATCH to update the object, instead of an HTTP PUT. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResource - -## NOTES - -## RELATED LINKS - - - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Move-AzureRmResource](./Move-AzureRmResource.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[Remove-AzureRmResource](./Remove-AzureRmResource.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceGroup.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceGroup.md deleted file mode 100644 index 3b0683fbf5..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceGroup.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 4E5C059B-36F3-41C8-9FDB-69F5318CF39B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresourcegroup -schema: 2.0.0 ---- - -# Set-AzureRmResourceGroup - -## SYNOPSIS -Modifies a resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SetByResourceGroupName (Default) -``` -Set-AzureRmResourceGroup [-Name] <String> [-Tag] <Hashtable> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### SetByResourceGroupId -``` -Set-AzureRmResourceGroup [-Tag] <Hashtable> [-Id] <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResourceGroup** cmdlet modifies the properties of a resource group. -You can use this cmdlet to add, change, or delete the Azure tags applied to a resource group. -Specify the *Name* parameter to identify the resource group and the *Tag* parameter to modify the tags. -You cannot use this cmdlet to change the name of a resource group. - -## EXAMPLES - -### Example 1: Apply a tag to a resource group -``` -PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{Department="IT"} -``` - -This command applies a Department tag with a value of IT to a resource group that has no existing tags. - -### Example 2: Add tags to a resource group -``` -PS C:\>$Tags = (Get-AzureRmResourceGroup -Name "ContosoRG").Tags -PS C:\> $Tags -PS C:\> $Tags += @{"Status"="Approved"; "FY2016"=$null} -PS C:\> Set-AzureRmResourceGroup -Name "ContosoRG" -Tag $Tags -PS C:> (Get-AzureRmResourceGroup -Name "ContosoRG").Tags -``` - -This example adds a Status tag with a value of Approved and an FY2016 tag to a resource group that -has existing tags. Because the tags you specify replace the existing tags, you must include the -existing tags in the new tag collection or you will lose them. -The first command gets the ContosoRG resource group and uses the dot method to get the value of its -Tags property. The command stores the tags in the $Tags variable. -The second command gets the tags in the $Tags variable. -The third command uses the += assignment operator to add the Status and FY2016 tags to the array of -tags in the $Tags variable. -The fourth command uses the *Tag* parameter of **Set-AzureRmResourceGroup** to apply the tags in -the $Tags variable to the ContosoRG resource group. -The fifth command gets all of the tags applied to the ContosoRG resource group. The output shows -that the resource group has the Department tag and the two new tags, Status and FY2015. - -### Example 3: Delete all tags for a resource group -``` -PS C:\>Set-AzureRmResourceGroup -Name "ContosoRG" -Tag @{} -``` - -This command specifies the *Tag* parameter with an empty hash table value to delete all tags from -the ContosoRG resource group. - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 modify. - -```yaml -Type: System.String -Parameter Sets: SetByResourceGroupId -Aliases: ResourceGroupId, ResourceId - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group to modify. - -```yaml -Type: System.String -Parameter Sets: SetByResourceGroupName -Aliases: ResourceGroupName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table. For example: -@{key0="value0";key1=$null;key2="value2"} -A tag is a name-value pair that you can create and apply to resources and resource groups. After -you assign tags to resources and groups, you can use the *Tag* parameter of Get-AzureRmResource and -Get-AzureRmResourceGroup to search for resources and groups by tag name or name and value. You can -use tags to categorize your resources, such as by department or cost center, or to track notes or -comments about the resources. -To add or change a tag, you must replace the collection of tags for the resource group. To delete a -tag, enter a hash table with all tags currently applied to the resource group, from -**Get-AzureRmResourceGroup**, except for the tag you want to delete. To delete all tags from a -resource group, specify an empty hash table: `@{}`. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.PSResourceGroup - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResource](./Get-AzureRmResource.md) - -[Get-AzureRmResourceGroup](./Get-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[Remove-AzureRmResourceGroup](./Remove-AzureRmResourceGroup.md) diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceLock.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceLock.md deleted file mode 100644 index 2e9e3b8fc2..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmResourceLock.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 770093CD-CE2A-4076-8A28-F4DCFFB7A075 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermresourcelock -schema: 2.0.0 ---- - -# Set-AzureRmResourceLock - -## SYNOPSIS -Modifies a resource lock. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### BySpecifiedScope (Default) -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -Scope <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroup -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### ByResourceGroupLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> -ResourceGroupName <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### BySubscription -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### BySubscriptionLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByTenantLevel -``` -Set-AzureRmResourceLock -LockName <String> -LockLevel <LockLevel> [-LockNotes <String>] [-Force] - -ResourceName <String> -ResourceType <String> [-TenantLevel] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>] - [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ByLockId -``` -Set-AzureRmResourceLock -LockLevel <LockLevel> [-LockNotes <String>] [-Force] -LockId <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmResourceLock** cmdlet modifies a resource lock. - -## EXAMPLES - -### Example 1: Update notes for a lock -``` -PS C:\>Set-AzureRmResourceLock -LockLevel CanNotDelete -LockNotes "Updated note" -LockName "ContosoSiteLock" -ResourceName "ContosoSite" -ResourceType "microsoft.web/sites" -ResourceGroupName "ResourceGroup11" -``` - -This command updates the note for a lock named ContosoSiteLock. - -## PARAMETERS - -### -ApiVersion -Specifies the version of the resource provider API to use. -If you do not specify a version, this cmdlet uses the latest available version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationAction -Specifies how this cmdlet responds to an information event. -The acceptable values for this parameter are: -- Continue -- Ignore -- Inquire -- SilentlyContinue -- Stop -- Suspend - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: infa - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InformationVariable -Specifies an information variable. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: iv - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockId -Specifies the ID of the lock that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: ByLockId -Aliases: Id, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockLevel -Specifies the level for the lock. -Currently, the only valid value is CanNotDelete. - -```yaml -Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Locks.LockLevel -Parameter Sets: (All) -Aliases: Level - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockName -Specifies the name of the lock that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope, ByResourceGroup, ByResourceGroupLevel, BySubscription, BySubscriptionLevel, ByTenantLevel -Aliases: ExtensionResourceName, Name - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockNotes -Specifies the notes for the lock. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: Notes - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroup, ByResourceGroupLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the name of the resource for which the lock applies. -For instance, to specify a database, use the following format: -Server`/`Database - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the resource type for which the lock applies. - -```yaml -Type: System.String -Parameter Sets: ByResourceGroupLevel, BySubscriptionLevel, ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope to which the lock applies. -For instance, to specify a database, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name`/providers/Microsoft.Sql/servers/`server name`/databases/`database name -To specify a resource group, use the following format: -`/subscriptions/`subscription ID`/resourceGroups/`resource group name - -```yaml -Type: System.String -Parameter Sets: BySpecifiedScope -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantLevel -Indicates that this cmdlet operates at the tenant level. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: ByTenantLevel -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceLock](./Get-AzureRmResourceLock.md) - -[New-AzureRmResourceLock](./New-AzureRmResourceLock.md) - -[Remove-AzureRmResourceLock](./Remove-AzureRmResourceLock.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmRoleDefinition.md b/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmRoleDefinition.md deleted file mode 100644 index 0f4003556b..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Set-AzureRmRoleDefinition.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 115A7612-4856-47AE-AEE4-918350CD7009 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/set-azurermroledefinition -schema: 2.0.0 ---- - -# Set-AzureRmRoleDefinition - -## SYNOPSIS -Modifies a custom role in Azure RBAC. -Provide the modified role definition either as a JSON file or as a PSRoleDefinition. -First, use the Get-AzureRmRoleDefinition command to retrieve the custom role that you wish to modify. -Then, modify the properties that you wish to change. -Finally, save the role definition using this command. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### InputFileParameterSet -``` -Set-AzureRmRoleDefinition -InputFile <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### RoleDefinitionParameterSet -``` -Set-AzureRmRoleDefinition -Role <PSRoleDefinition> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The Set-AzureRmRoleDefinition cmdlet updates an existing custom role in Azure Role-Based Access Control. -Provide the updated role definition as an input to the command as a JSON file or a PSRoleDefinition object. -The role definition for the updated custom role MUST contain the Id and all other required properties of the role even if they are not updated: DisplayName, Description, Actions, AssignableScopes. -NotActions, DataActions, NotDataActions are optional. -Following is a sample updated role definition json for Set-AzureRmRoleDefinition -{ - "Id": "52a6cc13-ff92-47a8-a39b-2a8205c3087e", - "Name": "Updated Role", - "Description": "Can monitor all resources and start and restart virtual machines", - "Actions": - \[ - "*/read", - "Microsoft.ClassicCompute/virtualmachines/restart/action", - "Microsoft.ClassicCompute/virtualmachines/start/action" - \], - "NotActions": - \[ - "*/write" - \], - "DataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read" - \], - "NotDataActions": - \[ - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" - \], - "AssignableScopes": \["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\] -} - -## EXAMPLES - -### Update using PSRoleDefinitionObject -``` -PS C:\> $roleDef = Get-AzureRmRoleDefinition "Contoso On-Call" - PS C:\> $roleDef.Actions.Add("Microsoft.ClassicCompute/virtualmachines/start/action") - PS C:\> $roleDef.Description = "Can monitor all resources and start and restart virtual machines" - PS C:\> $roleDef.AssignableScopes = @("/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") - - PS C:\> Set-AzureRmRoleDefinition -Role $roleDef -``` - -### Create using JSON file -``` -PS C:\> Set-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. -Id property is Required. - -```yaml -Type: System.String -Parameter Sets: InputFileParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Role definition object to be updated - -```yaml -Type: Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameter Sets: RoleDefinitionParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition -Parameters: Role (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition - -## NOTES -Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment - -## RELATED LINKS - -[Get-AzureRmProviderOperation](./Get-AzureRmProviderOperation.md) - -[Get-AzureRmRoleDefinition](./Get-AzureRmRoleDefinition.md) - -[New-AzureRmRoleDefinition](./New-AzureRmRoleDefinition.md) - -[Remove-AzureRmRoleDefinition](./Remove-AzureRmRoleDefinition.md) - diff --git a/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmDeployment.md deleted file mode 100644 index e83bfb30ff..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmDeployment.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/stop-azurermdeployment -schema: 2.0.0 ---- - -# Stop-AzureRmDeployment - -## SYNOPSIS -Cancal a running deployment - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StopByDeploymentName (Default) -``` -Stop-AzureRmDeployment [-Name] <String> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByDeploymentId -``` -Stop-AzureRmDeployment -Id <String> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByInputObject -``` -Stop-AzureRmDeployment -InputObject <PSDeployment> [-PassThru] [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmDeployment** cmdlet cancels a deployment at subscription scope that has started but not completed. -To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. - -To create a deployment at subscription scope, use the New-AzureRmDeployment cmdlet. - -This cmdlet stops only one running deployment. Use the *Name* parameter to stop a specific deployment. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-AzureRmDeployment -Name "deployment01" -``` - -This command cancels a running deployment "deployment01" at the current subscription scope. - -### Example 2 -``` -PS C:\>Get-AzureRmDeployment -Name "deployment01" | Stop-AzureRmDeployment -``` - -This command gets the deployment "deployment01" at the current subscription scope and cancels it. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: 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 resource Id of the deployment. -example: /subscriptions/{subId}/providers/Microsoft.Resources/deployments/{deploymentName} - -```yaml -Type: String -Parameter Sets: StopByDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The deployment object. - -```yaml -Type: PSDeployment -Parameter Sets: StopByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the deployment. - -```yaml -Type: String -Parameter Sets: StopByDeploymentName -Aliases: DeploymentName - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -{{Fill PassThru Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmResourceGroupDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmResourceGroupDeployment.md deleted file mode 100644 index 153b2592fd..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Stop-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 089954C3-7F3E-46C2-AA93-C0151EACDA2F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/stop-azurermresourcegroupdeployment -schema: 2.0.0 ---- - -# Stop-AzureRmResourceGroupDeployment - -## SYNOPSIS -Cancels a resource group deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StopByResourceGroupDeploymentName (Default) -``` -Stop-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### StopByResourceGroupDeploymentId -``` -Stop-AzureRmResourceGroupDeployment -Id <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmResourceGroupDeployment** cmdlet cancels an Azure resource group deployment that has started but not completed. -To stop a deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or Failed. -An Azure resource is a user-managed entity, such as a website, database, or database server. -A resource group is a collection of resources that are deployed as a unit. -To deploy a resource group, use the New-AzureRmResourceGroupDeployment cmdlet. -The New-AzureRmResource cmdlet creates a new resource, but it does not trigger a resource group deployment operation that this cmdlet can stop. -This cmdlet stops only one running deployment. -Use the *Name* parameter to stop a specific deployment. -If you omit the *Name* parameter, **Stop-AzureRmResourceGroupDeployment** searches for a running deployment and stops it. -If the cmdlet finds more than one running deployment, the command fails. - -## EXAMPLES - -### Example 1: Starting and stopping a resource group deployment - -```powershell -PS C:\> New-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azuredeploy.json -TemplateParameterFile .\storage-account-create-azuredeploy.parameters.json -AsJob - -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Long Running... AzureLongRun... Running True localhost New-AzureRmResourceGro... - -PS C:\> Stop-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -True - -PS C:\> Get-Job 1 - -Id Name PSJobTypeName State HasMoreData Location Command --- ---- ------------- ----- ----------- -------- ------- -1 Long Running... AzureLongRun... Failed True localhost New-AzureRmResourceGro... -``` - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentId -Aliases: DeploymentId, ResourceId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group deployment to stop. -If you do not specify this parameter, this cmdlet searches for a running deployment in the resource group and stops it. -If it finds more than one running deployment, the command fails. -To get the deployment name, use the Get-AzureRmResourceGroupDeployment cmdlet. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentName -Aliases: DeploymentName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group. -This cmdlet stops the deployment of the resource group that this parameter specifies. - -```yaml -Type: System.String -Parameter Sets: StopByResourceGroupDeploymentName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResource](./New-AzureRmResource.md) - -[New-AzureRmResourceGroup](./New-AzureRmResourceGroup.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Test-AzureRmResourceGroupDeployment](./Test-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmDeployment.md deleted file mode 100644 index e428c77d61..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmDeployment.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/test-azurermdeployment -schema: 2.0.0 ---- - -# Test-AzureRmDeployment - -## SYNOPSIS -Validates a deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -Test-AzureRmDeployment -Location <String> -TemplateFile <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterObject <Hashtable> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterObject <Hashtable> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterFile <String> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterFile <String> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterUri <String> -TemplateFile <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -Test-AzureRmDeployment -Location <String> -TemplateParameterUri <String> -TemplateUri <String> - [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -Test-AzureRmDeployment -Location <String> -TemplateUri <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmDeployment** cmdlet determines whether a deployment template and its parameter values are valid. - -## EXAMPLES - -### Example 1: Test deployment with a custom template and parameter file -``` -PS C:\>Test-AzureRmDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -``` - -This command tests a deployment at the current subscription scope using the given template file and parameters file. - -## PARAMETERS - -### -ApiVersion -When set, indicates the version of the resource provider API to use. -If not specified, the API version is automatically determined as the latest available. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The location to store deployment data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pre -When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Local path to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -A file that has the template parameters. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -A hash table which represents the parameters. - -```yaml -Type: Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Uri to the template parameter file. - -```yaml -Type: String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Uri to the template file. - -```yaml -Type: String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -System.Collections.Hashtable - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceManagerError - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmResourceGroupDeployment.md b/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmResourceGroupDeployment.md deleted file mode 100644 index f66114382e..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Test-AzureRmResourceGroupDeployment.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: 0143CE35-3B1D-4829-B880-A5CA25B83883 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/test-azurermresourcegroupdeployment -schema: 2.0.0 ---- - -# Test-AzureRmResourceGroupDeployment - -## SYNOPSIS -Validates a resource group deployment. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ByTemplateFileWithNoParameters (Default) -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateFile <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### ByTemplateFileAndParameterObject -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterObject <Hashtable> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterObject -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterObject <Hashtable> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateFileAndParameterFile -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterFile <String> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterFile -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterFile <String> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateFileAndParameterUri -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterUri <String> - -TemplateFile <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriAndParameterUri -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateParameterUri <String> - -TemplateUri <String> [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### ByTemplateUriWithNoParameters -``` -Test-AzureRmResourceGroupDeployment -ResourceGroupName <String> [-Mode <DeploymentMode>] - [-RollbackToLastDeployment] [-RollBackDeploymentName <String>] -TemplateUri <String> [-ApiVersion <String>] - [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Test-AzureRmResourceGroupDeployment** cmdlet determines whether an Azure resource group deployment template and its parameter values are valid. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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: -- Incremental -- Complete - -```yaml -Type: Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Pre -Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollBackDeploymentName -Rollback to the successful deployment with the given name in the resource group, should not be used if -RollbackToLastDeployment is used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RollbackToLastDeployment -Rollback to the last successful deployment in the resource group, should not be present if -RollBackDeploymentName is used. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFile -Specifies the full path of a JSON template file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileWithNoParameters, ByTemplateFileAndParameterObject, ByTemplateFileAndParameterFile, ByTemplateFileAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterFile -Specifies the full path of a JSON file that contains the names and values of the template parameters. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterFile, ByTemplateUriAndParameterFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterObject -Specifies a hash table of template parameter names and values. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: ByTemplateFileAndParameterObject, ByTemplateUriAndParameterObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateParameterUri -Specifies the URI of a template parameters file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateFileAndParameterUri, ByTemplateUriAndParameterUri -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TemplateUri -Specifies the URI of a JSON template file. - -```yaml -Type: System.String -Parameter Sets: ByTemplateUriAndParameterObject, ByTemplateUriAndParameterFile, ByTemplateUriAndParameterUri, ByTemplateUriWithNoParameters -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.ResourceManager.Models.PSResourceManagerError - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceGroupDeployment](./Get-AzureRmResourceGroupDeployment.md) - -[New-AzureRmResourceGroupDeployment](./New-AzureRmResourceGroupDeployment.md) - -[Remove-AzureRmResourceGroupDeployment](./Remove-AzureRmResourceGroupDeployment.md) - -[Stop-AzureRmResourceGroupDeployment](./Stop-AzureRmResourceGroupDeployment.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Unregister-AzureRmResourceProvider.md b/azurermps-2.5.0/AzureRm.Resources/Unregister-AzureRmResourceProvider.md deleted file mode 100644 index 080209ac57..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Unregister-AzureRmResourceProvider.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml -Module Name: AzureRM.Resources -ms.assetid: D5126B7B-7FBB-4C72-B77E-13ADE2BE9B1B -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/unregister-azurermresourceprovider -schema: 2.0.0 ---- - -# Unregister-AzureRmResourceProvider - -## SYNOPSIS -Unregisters a resource provider. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Unregister-AzureRmResourceProvider -ProviderNamespace <String> [-ApiVersion <String>] [-Pre] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Unregister-AzureRmResourceProvider** cmdlet unregisters an Azure resource provider. - -## EXAMPLES - -## PARAMETERS - -### -ApiVersion -Specifies the API version that is supported by the resource Provider. -You can specify a different version than the default version. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderNamespace -Specifies the namespace of the resource provider. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmResourceProvider](./Get-AzureRmResourceProvider.md) - -[Register-AzureRmResourceProvider](./Register-AzureRmResourceProvider.md) - - diff --git a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADApplication.md b/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADApplication.md deleted file mode 100644 index 7fbe37b346..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADApplication.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermadapplication -schema: 2.0.0 ---- - -# Update-AzureRmADApplication - -## SYNOPSIS -Updates an existing azure active directory application. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ApplicationObjectIdWithUpdateParamsParameterSet (Default) -``` -Update-AzureRmADApplication -ObjectId <Guid> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ApplicationIdWithUpdateParamsParameterSet -``` -Update-AzureRmADApplication -ApplicationId <Guid> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectWithUpdateParamsParameterSet -``` -Update-AzureRmADApplication -InputObject <PSADApplication> [-DisplayName <String>] [-HomePage <String>] - [-IdentifierUri <String[]>] [-ReplyUrl <String[]>] [-AvailableToOtherTenants <Boolean>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing azure active directory application. -To update the credentials associated with this application, please use the New-AzureRmADAppCredential cmdlet. - -## EXAMPLES - -### Example 1 - Update the display name of an application - -``` -PS C:\> Update-AzureRmADApplication -ObjectId fb7b3405-ca44-4b5b-8584-12392f5d96d7 -DisplayName MyNewDisplayName -``` - -Updates the display name of the application with object id 'fb7b3405-ca44-4b5b-8584-12392f5d96d7' to be 'MyNewDisplayName'. - -### Example 2 - Update all properties of an application - -``` -PS C:\> Update-AzureRmADApplication -ObjectId fb7b3405-ca44-4b5b-8584-12392f5d96d7 -DisplayName MyNewDisplayName -HomePage https://www.microsoft.com -IdentifierUris "https://UpdateAppUri" -``` - -Updates the properties of an application with object id 'fb7b3405-ca44-4b5b-8584-12392f5d96d7'. - -### Example 3 - Update the display name of an application using piping - -``` -PS C:\> Get-AzureRmADApplication -ObjectId fb7b3405-ca44-4b5b-8584-12392f5d96d7 | Update-AzureRmADApplication -DisplayName MyNewDisplayName -``` - -Gets the application with object id 'fb7b3405-ca44-4b5b-8584-12392f5d96d7' and pipes that to the Update-AzureRmADApplication cmdlet to update the display name of the application to "MyNewDisplayName". - -## PARAMETERS - -### -ApplicationId -The application id of the application to update. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AvailableToOtherTenants -True if the application is shared with other tenants; otherwise, false. - -```yaml -Type: System.Boolean -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Boolean -Parameter Sets: InputObjectWithUpdateParamsParameterSet -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. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the application to update. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -The URL to the application's homepage. - -```yaml -Type: System.String -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdentifierUri -The URIs that identify the application. - -```yaml -Type: System.String[] -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: IdentifierUris - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: IdentifierUris - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The object representing the application to update. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the application to update. - -```yaml -Type: System.Guid -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplyUrl -Specifies the URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to. - -```yaml -Type: System.String[] -Parameter Sets: ApplicationObjectIdWithUpdateParamsParameterSet, ApplicationIdWithUpdateParamsParameterSet -Aliases: ReplyUrls - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String[] -Parameter Sets: InputObjectWithUpdateParamsParameterSet -Aliases: ReplyUrls - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication -Parameters: InputObject (ByValue) - -### System.String - -### System.String[] - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADApplication - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADServicePrincipal.md b/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADServicePrincipal.md deleted file mode 100644 index 571b98c132..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADServicePrincipal.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermadserviceprincipal -schema: 2.0.0 ---- - -# Update-AzureRmADServicePrincipal - -## SYNOPSIS -Updates an existing azure active directory service principal. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SpObjectIdWithDisplayNameParameterSet (Default) -``` -Update-AzureRmADServicePrincipal -ObjectId <Guid> [-DisplayName <String>] [-Homepage <String>] - [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SpApplicationIdWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -ApplicationId <Guid> [-Homepage <String>] [-IdentifierUri <String[]>] - [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### SPNWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -ServicePrincipalName <String> [-DisplayName <String>] [-Homepage <String>] - [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] [-PasswordCredential <PasswordCredential[]>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectWithDisplayNameParameterSet -``` -Update-AzureRmADServicePrincipal -InputObject <PSADServicePrincipal> [-DisplayName <String>] - [-Homepage <String>] [-IdentifierUri <String[]>] [-KeyCredential <KeyCredential[]>] - [-PasswordCredential <PasswordCredential[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing azure active directory service principal. -To update the credentials associated with this service principal, please use New-AzureRmADSpCredential cmdlet. -To update the properties associated with the underlying application, please use Update-AzureRmADApplication cmdlet. - -## EXAMPLES - -### Example 1 - Update the display name of a service principal - -``` -PS C:\> Update-AzureRmADServicePrincipal -ObjectId 784136ca-3ae2-4fdd-a388-89d793e7c780 -DisplayName MyNewDisplayName -``` - -Updates the display name of the service principal with object id '784136ca-3ae2-4fdd-a388-89d793e7c780' to be 'MyNewDisplayName'. - -### Example 2 - Update the display name of a service principal using piping - -``` -PS C:\> Get-AzureRmADServicePrincipal -ObjectId 784136ca-3ae2-4fdd-a388-89d793e7c780 | Update-AzureRmADServicePrincipal -DisplayName MyNewDisplayName -``` - -Gets the service principal with object id '784136ca-3ae2-4fdd-a388-89d793e7c780' and pipes that to the Update-AzureRmADServicePrincipal cmdlet to update the display name of the service principal to "MyNewDisplayName". - -## PARAMETERS - -### -ApplicationId -The application id of the service principal to update. - -```yaml -Type: System.Guid -Parameter Sets: SpApplicationIdWithDisplayNameParameterSet -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name for the service principal. - -```yaml -Type: System.String -Parameter Sets: SpObjectIdWithDisplayNameParameterSet, SPNWithDisplayNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectWithDisplayNameParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Homepage -The homepage for the service principal. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentifierUri -The identifier URI(s) for the service principal. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the service principal to update. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameter Sets: InputObjectWithDisplayNameParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KeyCredential -The key credential(s) for the service principal. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.Models.KeyCredential[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the service principal to update. - -```yaml -Type: System.Guid -Parameter Sets: SpObjectIdWithDisplayNameParameterSet -Aliases: ServicePrincipalObjectId - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordCredential -The password credential(s) for the service principal. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.Models.PasswordCredential[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalName -The SPN of the service principal to update. - -```yaml -Type: System.String -Parameter Sets: SPNWithDisplayNameParameterSet -Aliases: SPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Guid - -### System.String - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal -Parameters: InputObject (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADServicePrincipal - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADUser.md b/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADUser.md deleted file mode 100644 index 767f5fa801..0000000000 --- a/azurermps-2.5.0/AzureRm.Resources/Update-AzureRmADUser.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml -Module Name: AzureRM.Resources -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.resources/update-azurermaduser -schema: 2.0.0 ---- - -# Update-AzureRmADUser - -## SYNOPSIS -Updates an existing active directory user. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UPNOrObjectIdParameterSet (Default) -``` -Update-AzureRmADUser -UPNOrObjectId <String> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### UPNParameterSet -``` -Update-AzureRmADUser -UserPrincipalName <String> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### ObjectIdParameterSet -``` -Update-AzureRmADUser -ObjectId <Guid> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### InputObjectParameterSet -``` -Update-AzureRmADUser -InputObject <PSADUser> [-DisplayName <String>] [-EnableAccount <Boolean>] - [-Password <SecureString>] [-ForceChangePasswordNextLogin] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -Updates an existing active directory user (work/school account also popularly known as org-id). -For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser - -## EXAMPLES - -### Example 1 - Update the display name of a user using object id - -``` -PS C:\> Update-AzureRmADUser -ObjectId 155a5c10-93a9-4941-a0df-96d83ab5ab24 -DisplayName MyNewDisplayName -``` - -Updates the display name of the user with object id '155a5c10-93a9-4941-a0df-96d83ab5ab24' to be 'MyNewDisplayName'. - -### Example 2 - Update the display name of a user using user principal name - -``` -PS C:\> Update-AzureRmADUser -UserPrincipalName foo@domain.com -DisplayName MyNewDisplayName -``` - -Updates the display name of the user with user principal name 'foo@domain.com' to be 'MyNewDisplayName'. - -### Example 3 - Update the display name of a user using piping - -``` -PS C:\> Get-AzureRmADUser -ObjectId 155a5c10-93a9-4941-a0df-96d83ab5ab24 | Update-AzureRmADUser -DisplayName MyNewDisplayName -``` - -Gets the user with object id '155a5c10-93a9-4941-a0df-96d83ab5ab24' and pipes that to the Update-AzureRmADUser cmdlet to update the display name of that user to 'MyNewDisplayName'. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 user. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAccount -true for enabling the account; otherwise, false. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceChangePasswordNextLogin -It must be specified if the user should change the password on the next successful login. -Only valid if password is updated otherwise it will be ignored. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The object representing the user to be updated. - -```yaml -Type: Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ObjectId -The object id of the user to be updated. - -```yaml -Type: System.Guid -Parameter Sets: ObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -New password for the user. - -```yaml -Type: System.Security.SecureString -Parameter Sets: UPNOrObjectIdParameterSet, UPNParameterSet, ObjectIdParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.Security.SecureString -Parameter Sets: InputObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UPNOrObjectId -The user principal name or object id of the user to be updated. - -```yaml -Type: System.String -Parameter Sets: UPNOrObjectIdParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -The user principal name of the user to be updated. - -```yaml -Type: System.String -Parameter Sets: UPNParameterSet -Aliases: UPN - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser -Parameters: InputObject (ByValue) - -### System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] - -### System.Security.SecureString - -## OUTPUTS - -### Microsoft.Azure.Graph.RBAC.Version1_6.ActiveDirectory.PSADUser - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Storage/Add-AzureRmStorageAccountNetworkRule.md b/azurermps-2.5.0/AzureRm.Storage/Add-AzureRmStorageAccountNetworkRule.md deleted file mode 100644 index 1bc4e27be5..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Add-AzureRmStorageAccountNetworkRule.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/add-azurermstorageaccountnetworkrule -schema: 2.0.0 ---- - -# Add-AzureRmStorageAccountNetworkRule - -## SYNOPSIS - Add IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NetWorkRuleString (Default) -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IpRuleObject -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NetworkRuleObject -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### IpRuleString -``` -Add-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -IPAddressOrRange <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Add-AzureRmStorageAccountNetworkRule** cmdlet adds IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Add several IpRules with IPAddressOrRange -``` -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/24","28.2.0.0/16" -``` - -This command add several IpRules with IPAddressOrRange. - -### Example 2: Add a VirtualNetworkRule with VirtualNetworkResourceID -``` -PS C:\>$subnet = Get-AzureRmVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzureRmVirtualNetworkSubnetConfig -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId $subnet[0].Id -``` - -This command add a VirtualNetworkRule with VirtualNetworkResourceID. - -### Example 3: Add VirtualNetworkRules with VirtualNetworkRule Objects from another account -``` -PS C:\> $networkrule = Get-AzureRMStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1" -PS C:\> Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules -``` - -This command add VirtualNetworkRules with VirtualNetworkRule Objects from another account. - -### Example 4: Add several IpRule with IpRule objects, input with JSON -``` -PS C:\>Add-AzureRMStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPRule (@{IPAddressOrRange="10.0.0.0/24";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) -``` - -This command add several IpRule with IpRule objects, input with JSON. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -The Array of IpAddressOrRange, add IpRules with the input IpAddressOrRange and default Action Allow to NetworkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: IpRuleString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to add to the NetworkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: IpRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -The Array of VirtualNetworkResourceId, will add VirtualNetworkRule with input VirtualNetworkResourceId and default Action Allow to NetworkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: NetWorkRuleString -Aliases: SubnetId, VirtualNetworkId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to add to the NetworkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: NetworkRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Storage/AzureRM.Storage.md b/azurermps-2.5.0/AzureRm.Storage/AzureRM.Storage.md deleted file mode 100644 index 822896d730..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/AzureRM.Storage.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -Module Name: AzureRM.Storage -Module Guid: da67eaa7-4cb1-4bfa-a194-8bf3faae8ac5 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage -Help Version: 4.2.3.0 -Locale: en-US ---- - -# AzureRM.Storage Module -## Description -This topic displays help topics for the Azure Storage Management Cmdlets. - -## AzureRM.Storage Cmdlets -### [Add-AzureRmStorageAccountNetworkRule](Add-AzureRmStorageAccountNetworkRule.md) - Add IpRules or VirtualNetworkRules to the NetworkRule property of a Storage account - -### [Get-AzureRmStorageAccount](Get-AzureRmStorageAccount.md) -Gets a Storage account. - -### [Get-AzureRmStorageAccountKey](Get-AzureRmStorageAccountKey.md) -Gets the access keys for an Azure Storage account. - -### [Get-AzureRmStorageAccountNameAvailability](Get-AzureRmStorageAccountNameAvailability.md) -Checks the availability of a Storage account name. - -### [Get-AzureRmStorageAccountNetworkRuleSet](Get-AzureRmStorageAccountNetworkRuleSet.md) -Get the NetWorkRule property of a Storage account - -### [Get-AzureRmStorageUsage](Get-AzureRmStorageUsage.md) -Gets the Storage resource usage of the current subscription. - -### [New-AzureRmStorageAccount](New-AzureRmStorageAccount.md) -Creates a Storage account. - -### [New-AzureRmStorageAccountKey](New-AzureRmStorageAccountKey.md) -Regenerates a storage key for an Azure Storage account. - -### [Remove-AzureRmStorageAccount](Remove-AzureRmStorageAccount.md) -Removes a Storage account from Azure. - -### [Remove-AzureRmStorageAccountNetworkRule](Remove-AzureRmStorageAccountNetworkRule.md) -Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account - -### [Set-AzureRmCurrentStorageAccount](Set-AzureRmCurrentStorageAccount.md) -Modifies the current Storage account of the specified subscription. - -### [Set-AzureRmStorageAccount](Set-AzureRmStorageAccount.md) -Modifies a Storage account. - -### [Update-AzureRmStorageAccountNetworkRuleSet](Update-AzureRmStorageAccountNetworkRuleSet.md) -Update the NetworkRule property of a Storage account - diff --git a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccount.md b/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccount.md deleted file mode 100644 index 87c6f5ac1b..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccount.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: E53D5040-C1E8-4DC1-8371-F41C00B666E3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccount -schema: 2.0.0 ---- - -# Get-AzureRmStorageAccount - -## SYNOPSIS -Gets a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### ResourceGroupParameterSet -``` -Get-AzureRmStorageAccount [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### AccountNameParameterSet -``` -Get-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccount** cmdlet gets a specified Storage account or all of the Storage accounts in a resource group or the subscription. - -## EXAMPLES - -### Example 1: Get a specified Storage account -``` -PS C:\>Get-AzureRmStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command gets the specified Storage account. - -### Example 2: Get all Storage accounts in a resource group -``` -PS C:\>Get-AzureRmStorageAccount -ResourceGroupName "RG01" -``` - -This command gets all of the Storage accounts in a resource group. - -### Example 3: Get all Storage accounts in the subscription -``` -PS C:\>Get-AzureRmStorageAccount -``` - -This command gets all of the Storage accounts in the subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Storage account to get. - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account to get. - -```yaml -Type: System.String -Parameter Sets: ResourceGroupParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: System.String -Parameter Sets: AccountNameParameterSet -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountKey.md b/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountKey.md deleted file mode 100644 index c7bc8bf478..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountKey.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: A57A9EFA-47AC-44D8-BFA7-CDE0E2A612B3 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountkey -schema: 2.0.0 ---- - -# Get-AzureRmStorageAccountKey - -## SYNOPSIS -Gets the access keys for an Azure Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountKey** cmdlet gets the access keys for an Azure Storage account. - -## EXAMPLES - -### Example 1: Get the access keys for a Storage account -``` -PS C:\>Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command gets the keys for the specified Azure Storage account. - -### Example 2: Get a specific access key for a Storage account -``` -This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.4, and later versions. -PS C:\>(Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount").Value[0] - -This command gets a specific key for a Storage account. This command works for Azure PowerShell version 1.3.2, and previous versions. -PS C:\>(Get-AzureRmStorageAccountKey -ResourceGroupName "RG01" -AccountName "mystorageaccount").Key1 -``` - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Storage account for which this cmdlet gets keys. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.StorageAccountKey - -## NOTES - -## RELATED LINKS - -[New-AzureRmStorageAccountKey](./New-AzureRmStorageAccountKey.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNameAvailability.md b/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNameAvailability.md deleted file mode 100644 index 9896f876df..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNameAvailability.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: F6EA099A-D588-49AE-9D2C-865BC32685BA -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountnameavailability -schema: 2.0.0 ---- - -# Get-AzureRmStorageAccountNameAvailability - -## SYNOPSIS -Checks the availability of a Storage account name. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountNameAvailability [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountNameAvailability** cmdlet checks whether the name of an Azure Storage account is valid and available to use. - -## EXAMPLES - -### Example 1: Check availability of a Storage account name -``` -PS C:\>Get-AzureRmStorageAccountNameAvailability -Name 'contosostorage03' -``` - -This command checks the availability of the name ContosoStorage03. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Storage account that this cmdlet checks. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.CheckNameAvailabilityResult - -## NOTES - -## RELATED LINKS - -[Azure Storage Manager Cmdlets](./AzureRM.Storage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md b/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md deleted file mode 100644 index c4287d1829..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageAccountNetworkRuleSet.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageaccountnetworkruleset -schema: 2.0.0 ---- - -# Get-AzureRmStorageAccountNetworkRuleSet - -## SYNOPSIS -Get the NetWorkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageAccountNetworkRuleSet** cmdlet gets the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Get NetworkRule property of a specified Storage account -``` -PS C:\> Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "rg1" -AccountName "mystorageaccount" -``` - -This command gets NetworkRule property of a specified Storage account - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageUsage.md b/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageUsage.md deleted file mode 100644 index 26580a5101..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Get-AzureRmStorageUsage.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 11AAA319-DDBB-4156-9BE7-4DE8B80A904C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/get-azurermstorageusage -schema: 2.0.0 ---- - -# Get-AzureRmStorageUsage - -## SYNOPSIS -Gets the Storage resource usage of the current subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmStorageUsage [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmStorageUsage** cmdlet gets the resource usage for Azure Storage for the current subscription. - -## EXAMPLES - -### Example 1: Get the storage resources usage -``` -PS C:\>Get-AzureRmStorageUsage -``` - -This command gets the Storage resources usage of the current subscription. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSUsage - -## NOTES - -## RELATED LINKS - -[Azure Storage Manager Cmdlets](./AzureRM.Storage.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccount.md b/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccount.md deleted file mode 100644 index 644e1fdfab..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccount.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: A3DA1205-B8FB-4B4C-9C40-AD303D038EDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/new-azurermstorageaccount -schema: 2.0.0 ---- - -# New-AzureRmStorageAccount - -## SYNOPSIS -Creates a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-SkuName] <String> - [-Location] <String> [-Kind <String>] [-AccessTier <String>] [-CustomDomainName <String>] - [-UseSubDomain <Boolean>] [-Tag <Hashtable>] [-EnableHttpsTrafficOnly <Boolean>] [-AssignIdentity] - [-NetworkRuleSet <PSNetworkRuleSet>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStorageAccount** cmdlet creates an Azure Storage account. - -## EXAMPLES - -### Example 1: Create a Storage account -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -``` - -This command creates a Storage account for the resource group name MyResourceGroup. - -### Example 2: Create a Blob Storage account with BlobStorage Kind and hot AccessTier -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind BlobStorage -AccessTier Hot -``` - -This command creates a Blob Storage account that with BlobStorage Kind and hot AccessTier - -### Example 3: Create a Storage account with Kind StorageV2, and Generate and Assign an Identity for Azure KeyVault. -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -SkuName Standard_GRS -Kind StorageV2 -AssignIdentity -``` - -This command creates a Storage account with Kind StorageV2. It also generates and assigns an identity that can be used to manage account keys through Azure KeyVault. - -### Example 4: Create a Storage account with NetworkRuleSet from JSON -``` -PS C:\>New-AzureRmStorageAccount -ResourceGroupName MyResourceGroup -AccountName mystorageaccount -Location westus -Type Standard_LRS -NetworkRuleSet (@{bypass="Logging,Metrics"; - ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, - @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); - virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, - @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); - defaultAction="Deny"}) -``` - -This command creates a Storage account that has NetworkRuleSet property from JSON - -## PARAMETERS - -### -AccessTier -Specifies the access tier of the Storage account that this cmdlet creates. -The acceptable values for this parameter are: Hot and Cool. -If you specify a value of BlobStorage for the *Kind* parameter, you must specify a value for the -*AccessTier* parameter. If you specify a value of Storage for this *Kind* parameter, do not specify -the *AccessTier* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Hot, Cool - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the name of the custom domain of the Storage account. -The default value is Storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableHttpsTrafficOnly -Indicates whether or not the Storage account only enables HTTPS traffic. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Kind -Specifies the kind of Storage account that this cmdlet creates. -The acceptable values for this parameter are: -- Storage. General purpose Storage account that supports storage of Blobs, Tables, Queues, Files and Disks. -- StorageV2. General Purpose Version 2 (GPv2) Storage account that supports Blobs, Tables, Queues, Files, and Disks, with advanced features like data tiering. -- BlobStorage. Blob Storage account which supports storage of Blobs only. -The default value is Storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Storage, StorageV2, BlobStorage - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the Storage account to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to create. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkRuleSet -NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to add the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU name of the Storage account that this cmdlet creates. -The acceptable values for this parameter are: -- Standard_LRS. Locally-redundant storage. -- Standard_ZRS. Zone-redundant storage. -- Standard_GRS. Geo-redundant storage. -- Standard_RAGRS. Read access geo-redundant storage. -- Premium_LRS. Premium locally-redundant storage. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountType, AccountType, Type -Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSubDomain -Indicates whether to enable indirect CName validation. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### 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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) diff --git a/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccountKey.md b/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccountKey.md deleted file mode 100644 index da4cbc805d..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/New-AzureRmStorageAccountKey.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: FDD2CE98-6C7E-4B95-BA5B-B03B6AC6EAEF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/new-azurermstorageaccountkey -schema: 2.0.0 ---- - -# New-AzureRmStorageAccountKey - -## SYNOPSIS -Regenerates a storage key for an Azure Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmStorageAccountKey [-ResourceGroupName] <String> [-Name] <String> [-KeyName] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmStorageAccountKey** cmdlet regenerates a storage key for an Azure Storage account. - -## EXAMPLES - -### Example 1: Regenerate a storage key -``` -PS C:\>New-AzureRmStorageKey -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -KeyName "key1" -``` - -This command regenerates a storage key for the specified Storage account. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -Specifies which key to regenerate. -The acceptable values for this parameter are: -- key1 -- key2 - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: key1, key2 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account for which to regenerate a storage key. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.Storage.Models.StorageAccountKey - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccountKey](./Get-AzureRmStorageAccountKey.md) diff --git a/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccount.md b/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccount.md deleted file mode 100644 index 0e9d62ec0f..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccount.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 006B4341-274C-4929-86EE-2E107BA9E485 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstorageaccount -schema: 2.0.0 ---- - -# Remove-AzureRmStorageAccount - -## SYNOPSIS -Removes a Storage account from Azure. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Remove-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageAccount** cmdlet removes a Storage account from Azure. - -## EXAMPLES - -### Example 1: Remove a Storage account -``` -PS C:\>Remove-AzureRmStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command removes the specified Storage account. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that contains the Storage account to remove. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Void - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccountNetworkRule.md b/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccountNetworkRule.md deleted file mode 100644 index eae5a9145f..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Remove-AzureRmStorageAccountNetworkRule.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/remove-azurermstorageaccountnetworkrule -schema: 2.0.0 ---- - -# Remove-AzureRmStorageAccountNetworkRule - -## SYNOPSIS -Remove IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### NetWorkRuleString (Default) -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkResourceId <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -### IpRuleObject -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> -IPRule <PSIpRule[]> - [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### NetworkRuleObject -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -VirtualNetworkRule <PSVirtualNetworkRule[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -### IpRuleString -``` -Remove-AzureRmStorageAccountNetworkRule [-ResourceGroupName] <String> [-Name] <String> - -IPAddressOrRange <String[]> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmStorageAccountNetworkRule** cmdlet removes IpRules or VirtualNetworkRules from the NetWorkRule property of a Storage account - -## EXAMPLES - -### Example 1: Remove several IpRules with IPAddressOrRange -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -IPAddressOrRange "10.0.0.0/24,28.1.0.0/16" -``` - -This command remove several IpRules with IPAddressOrRange. - -### Example 2: Remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkRules (@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}) -``` - -This command remove a VirtualNetworkRule with VirtualNetworkRule Object input with JSON. - -### Example 3: Remove first IpRule with pipeline -``` -PS C:\>(Get-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount").IpRules[0] | Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -``` - -This command remove first IpRule with pipeline. - -### Example 4: Remove several VirtualNetworkRules with VirtualNetworkResourceID -``` -PS C:\>Remove-AzureRmStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -VirtualNetworkResourceId "/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1","/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2" -``` - -This command remove several VirtualNetworkRules with VirtualNetworkResourceID. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressOrRange -The Array of IpAddressOrRange, will remove IpRule with same IpAddressOrRange from the NetWorkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: IpRuleString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to remove from the NetWorkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: IpRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkResourceId -The Array of VirtualNetworkResourceId, will remove VirtualNetworkRule with same VirtualNetworkResourceId from the NetWorkRule Property. - -```yaml -Type: System.String[] -Parameter Sets: NetWorkRuleString -Aliases: SubnetId, VirtualNetworkId - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to remove from the NetWorkRule Property. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: NetworkRuleObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmCurrentStorageAccount.md b/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmCurrentStorageAccount.md deleted file mode 100644 index 2d249dc376..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmCurrentStorageAccount.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 15973FE8-16C1-4B71-A3A8-6D6F67A96FDF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/set-azurermcurrentstorageaccount -schema: 2.0.0 ---- - -# Set-AzureRmCurrentStorageAccount - -## SYNOPSIS -Modifies the current Storage account of the specified subscription. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### UsingResourceGroupAndNameParameterSet (Default) -``` -Set-AzureRmCurrentStorageAccount -ResourceGroupName <String> -Name <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### UsingStorageContext -``` -Set-AzureRmCurrentStorageAccount -Context <IStorageContext> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmCurrentStorageAccount** cmdlet modifies the current Azure Storage account of the specified Azure subscription in Azure PowerShell. -The current Storage account is used as the default when you access Storage without specifying a Storage account name. - -## EXAMPLES - -### Example 1: Set the current Storage account -``` -PS C:\>Set-AzureRmCurrentStorageAccount -ResourceGroupName "RG01" -AccountName "mystorageaccount" -``` - -This command sets the default Storage account for the specified subscription. - -## PARAMETERS - -### -Context -Specifies an **AzureStorageContext** object for the current Storage account. -To obtain a storage context object, use the New-AzureStorageContext cmdlet. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext -Parameter Sets: UsingStorageContext -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.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 Storage account that this cmdlet modifies. - -```yaml -Type: System.String -Parameter Sets: UsingResourceGroupAndNameParameterSet -Aliases: StorageAccountName, AccountName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group that contains the Storage account to modify. - -```yaml -Type: System.String -Parameter Sets: UsingResourceGroupAndNameParameterSet -Aliases: - -Required: True -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext - -### System.String - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Set-AzureRmStorageAccount](./Set-AzureRmStorageAccount.md) - - diff --git a/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmStorageAccount.md b/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmStorageAccount.md deleted file mode 100644 index caab6547f8..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Set-AzureRmStorageAccount.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -ms.assetid: 4D7EEDD7-89D4-4B1E-A9A1-B301E759CE72 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/set-azurermstorageaccount -schema: 2.0.0 ---- - -# Set-AzureRmStorageAccount - -## SYNOPSIS -Modifies a Storage account. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### StorageEncryption (Default) -``` -Set-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] - [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] - [-EnableHttpsTrafficOnly <Boolean>] [-StorageEncryption] [-AssignIdentity] - [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-AsJob] [-DefaultProfile <IAzureContextContainer>] - [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### KeyvaultEncryption -``` -Set-AzureRmStorageAccount [-ResourceGroupName] <String> [-Name] <String> [-Force] [-SkuName <String>] - [-AccessTier <String>] [-CustomDomainName <String>] [-UseSubDomain <Boolean>] [-Tag <Hashtable>] - [-EnableHttpsTrafficOnly <Boolean>] [-KeyvaultEncryption] -KeyName <String> -KeyVersion <String> - -KeyVaultUri <String> [-AssignIdentity] [-NetworkRuleSet <PSNetworkRuleSet>] [-UpgradeToStorageV2] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmStorageAccount** cmdlet modifies an Azure Storage account. -You can use this cmdlet to modify the account type, update a customer domain, or set tags on a Storage account. - -## EXAMPLES - -### Example 1: Set the Storage account type -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -Type "Standard_RAGRS" -``` - -This command sets the Storage account type to Standard_RAGRS. - -### Example 2: Set a custom domain for a Storage account -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -CustomDomainName "www.contoso.com" -UseSubDomain $True -``` - -This command sets a custom domain for a Storage account. - -### Example 3: Set the access tier value -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -AccessTier Cool -``` - -The command sets the Access Tier value to be cool. - -### Example 4: Set the custom domain and tags -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -CustomDomainName "www.domainname.com" -UseSubDomain $true -Tag @{tag0="value0";tag1="value1";tag2="value2"} -``` - -The command sets the custom domain and tags for a Storage account. - -### Example 5: Set Encryption KeySource to Keyvault -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -AssignIdentity -PS C:\>$account = Get-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" - -PS C:\>$keyVault = New-AzureRmKeyVault -VaultName "MyKeyVault" -ResourceGroupName "MyResourceGroup" -Location "EastUS2" -PS C:\>$key = Add-AzureKeyVaultKey -VaultName "MyKeyVault" -Name "MyKey" -Destination 'Software' -PS C:\>Set-AzureRmKeyVaultAccessPolicy -VaultName "MyKeyVault" -ObjectId $account.Identity.PrincipalId -PermissionsToKeys wrapkey,unwrapkey,get - -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -KeyvaultEncryption -KeyName $key.Name -KeyVersion $key.Version -KeyVaultUri $keyVault.VaultUri -``` - -This command set Encryption KeySource with a new created Keyvault. - -### Example 6: Set Encryption KeySource to "Microsoft.Storage" -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -StorageEncryption -``` - -This command set Encryption KeySource to "Microsoft.Storage" - -### Example 7: Set NetworkRuleSet property of a Storage account with JSON -``` -PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -NetworkRuleSet (@{bypass="Logging,Metrics"; - ipRules=(@{IPAddressOrRange="20.11.0.0/16";Action="allow"}, - @{IPAddressOrRange="10.0.0.0/7";Action="allow"}); - virtualNetworkRules=(@{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"}, - @{VirtualNetworkResourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2";Action="allow"}); - defaultAction="allow"}) -``` - -This command sets NetworkRuleSet property of a Storage account with JSON - -### Example 8: Get NetworkRuleSet property from a Storage account, and set it to another Storage account -``` -PS C:\> $networkRuleSet = (Get-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount").NetworkRuleSet -PS C:\> Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount2" -NetworkRuleSet $networkRuleSet -``` - -This first command gets NetworkRuleSet property from a Storage account, and the second command sets it to another Storage account - -### Example 9: Upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account -``` -PS C:\> Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorageaccount" -UpgradeToStorageV2 -``` - -The command upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account. - -## PARAMETERS - -### -AccessTier -Specifies the access tier of the Storage account that this cmdlet modifies. -The acceptable values for this parameter are: Hot and Cool. -If you change the access tier, it may result in additional charges. For more information, see -[Azure Blob Storage: Hot and cool storage tiers](https://go.microsoft.com/fwlink/?LinkId=786482). -If the Storage account has Kind as StorageV2 or BlobStorage, you can specify the *AccessTier* parameter. -If the Storage account has Kind as Storage, do not specify the *AccessTier* parameter. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Hot, Cool - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Generate and assign a new Storage account Identity for this Storage account for use with key management services like Azure KeyVault. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomDomainName -Specifies the name of the custom domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableHttpsTrafficOnly -Indicates whether or not the Storage account only enables HTTPS traffic. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the change to be written to the Storage account. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyName -If using -KeyvaultEncryption to enable encryption with Key Vault, specify the Keyname property with this option. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyvaultEncryption -Indicates whether or not to use Microsoft KeyVault for the encryption keys when using Storage Service Encryption. -If KeyName, KeyVersion, and KeyVaultUri are all set, KeySource will be set to Microsoft.Keyvault whether this parameter is set or not. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultUri -When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Vault. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVersion -When using Key Vault Encryption by specifying the -KeyvaultEncryption parameter, use this option to specify the URI to the Key Version. - -```yaml -Type: System.String -Parameter Sets: KeyvaultEncryption -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account to modify. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkRuleSet -NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as services allowed to bypass the rules and how to handle requests that don't match any of the defined rules. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group in which to modify the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkuName -Specifies the SKU name of the Storage account. -The acceptable values for this parameter are: -- Standard_LRS - Locally-redundant storage. -- Standard_ZRS - Zone-redundant storage. -- Standard_GRS - Geo-redundant storage. -- Standard_RAGRS - Read access geo-redundant storage. -- Premium_LRS - Premium locally-redundant storage. -You cannot change Standard_ZRS and Premium_LRS types to other account types. -You cannot change other account types to Standard_ZRS or Premium_LRS. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountType, AccountType, Type -Accepted values: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageEncryption -Indicates whether or not to set the Storage account encryption to use Microsoft-managed keys. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: StorageEncryption -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Key-value pairs in the form of a hash table set as tags on the server. For example: -@{key0="value0";key1=$null;key2="value2"} - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: Tags - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpgradeToStorageV2 -Upgrade Storage account Kind from Storage or BlobStorage to StorageV2. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSubDomain -Indicates whether to enable indirect CName validation. - -```yaml -Type: System.Nullable`1[System.Boolean] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Collections.Hashtable - -### System.Boolean - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSStorageAccount - -## NOTES - -## RELATED LINKS - -[Get-AzureRmStorageAccount](./Get-AzureRmStorageAccount.md) - -[New-AzureRmStorageAccount](./New-AzureRmStorageAccount.md) - -[Remove-AzureRmStorageAccount](./Remove-AzureRmStorageAccount.md) diff --git a/azurermps-2.5.0/AzureRm.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md b/azurermps-2.5.0/AzureRm.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md deleted file mode 100644 index e41b1e33f6..0000000000 --- a/azurermps-2.5.0/AzureRm.Storage/Update-AzureRmStorageAccountNetworkRuleSet.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Management.Storage.dll-Help.xml -Module Name: AzureRM.Storage -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.storage/update-azurermstorageaccountnetworkruleset -schema: 2.0.0 ---- - -# Update-AzureRmStorageAccountNetworkRuleSet - -## SYNOPSIS -Update the NetworkRule property of a Storage account - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Update-AzureRmStorageAccountNetworkRuleSet [-ResourceGroupName] <String> [-Name] <String> - [-Bypass <PSNetWorkRuleBypassEnum>] [-DefaultAction <PSNetWorkRuleDefaultActionEnum>] [-IPRule <PSIpRule[]>] - [-VirtualNetworkRule <PSVirtualNetworkRule[]>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Update-AzureRmStorageAccountNetworkRuleSet** cmdlet updates the NetworkRule property of a Storage account - -## EXAMPLES - -### Example 1: Update all properties of NetworkRule, input Rules with JSON -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Bypass Logging,Metrics -DefaultAction Allow -IpRule (@{IPAddressOrRange="10.0.0.0/24";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"}) - -VirtualNetworkRule (@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1";Action="allow"},@{VirtualNetworkReourceId="/subscriptions/s1/resourceGroups/g1/providers/Microsoft.Network/virtualN - etworks/vnet2/subnets/subnet2";Action="allow"}) -``` - -This command update all properties of NetworkRule, input Rules with JSON. - -### Example 2: Update Bypass property of NetworkRule -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -Bypass AzureServices,Metrics -``` - -This command update Bypass property of NetworkRule (other properties won't change). - -### Example 3: Clean up rules of NetworkRule of a Storage account -``` -PS C:\> Update-AzureRmStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -AccountName "mystorageaccount" -IpRule @() -VirtualNetworkRule @() -``` - -This command clean up rules of NetworkRule of a Storage account (other properties not change). - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Bypass -The Bypass value to update to the NetworkRule property of a Storage account. -The allowed value are none or any combination of: -• Logging -• Metrics -• Azureservices - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleBypassEnum -Parameter Sets: (All) -Aliases: -Accepted values: None, Logging, Metrics, AzureServices - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultAction -The DefaultAction value to update to the NetworkRule property of a Storage account. -The allowed Options: -• Allow -• Deny - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSNetWorkRuleDefaultActionEnum -Parameter Sets: (All) -Aliases: -Accepted values: Deny, Allow - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPRule -The Array of IpRule objects to update to the NetworkRule Property of a Storage account. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: StorageAccountName, AccountName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group contains the Storage account. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualNetworkRule -The Array of VirtualNetworkRule objects to update to the NetworkRule Property of a Storage account. - -```yaml -Type: Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### Microsoft.Azure.Commands.Management.Storage.Models.PSIpRule[] -Parameters: IPRule (ByValue) - -### Microsoft.Azure.Commands.Management.Storage.Models.PSVirtualNetworkRule[] -Parameters: VirtualNetworkRule (ByValue) - -## OUTPUTS - -### Microsoft.Azure.Commands.Management.Storage.Models.PSNetworkRuleSet - -## NOTES - -## RELATED LINKS diff --git a/azurermps-2.5.0/AzureRm.UsageAggregates/AzureRM.UsageAggregates.md b/azurermps-2.5.0/AzureRm.UsageAggregates/AzureRM.UsageAggregates.md deleted file mode 100644 index a20c5ebe02..0000000000 --- a/azurermps-2.5.0/AzureRm.UsageAggregates/AzureRM.UsageAggregates.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -Module Name: AzureRM.UsageAggregates -Module Guid: e43e47c8-8bff-4013-b003-ded1741f403a -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.usageaggregates -Help Version: 4.0.0.0 -Locale: en-US ---- - -# AzureRM.UsageAggregates Module -## Description -This topic displays help topics for the Azure Usage Aggregate Cmdlets. - -## AzureRM.UsageAggregates Cmdlets -### [Get-UsageAggregates](Get-UsageAggregates.md) -Gets the reported Azure subscription usage details. - diff --git a/azurermps-2.5.0/AzureRm.UsageAggregates/Get-UsageAggregates.md b/azurermps-2.5.0/AzureRm.UsageAggregates/Get-UsageAggregates.md deleted file mode 100644 index 7dca4f364b..0000000000 --- a/azurermps-2.5.0/AzureRm.UsageAggregates/Get-UsageAggregates.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.UsageAggregates.dll-Help.xml -Module Name: AzureRM -ms.assetid: 52B3ECCB-80E5-4E16-954A-B83D0BDC7E22 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.usageaggregates/get-usageaggregates -schema: 2.0.0 ---- - -# Get-UsageAggregates - -## SYNOPSIS -Gets the reported Azure subscription usage details. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-UsageAggregates -ReportedStartTime <DateTime> -ReportedEndTime <DateTime> - [-AggregationGranularity <AggregationGranularity>] [-ShowDetails <Boolean>] [-ContinuationToken <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-UsageAggregates** cmdlet gets aggregated Azure subscription usage data by the following properties: - -- Start and end times of when the usage was reported. - -- Aggregation precision, either daily or hourly. - -- Instance level detail for multiple instances of the same resource. - -For consistent results, the returned data is based on when the usage details were reported by the Azure resource. - -For more information, see Azure Billing REST API Referencehttps://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c (https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c) in the Microsoft Developer Network library. - -## EXAMPLES - -### Example 1: Retrieve subscription data -``` -PS C:\>Get-UsageAggregates -ReportedStartTime "5/2/2015" -ReportedEndTime "5/5/2015" -``` - -This command retrieves the reported usage data for the subscription between 5/2/2015 and 5/5/2015. - -## PARAMETERS - -### -AggregationGranularity -Specifies the aggregation precision of the data. -Valid values are: Daily and Hourly. - -The default value is Daily. - -```yaml -Type: AggregationGranularity -Parameter Sets: (All) -Aliases: -Accepted values: Daily, Hourly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuationToken -Specifies the continuation token that was retrieved from the response body in the previous call. -For a large result set, responses are paged by using continuation tokens. -The continuation token serves as a bookmark for progress. -If you do not specify this parameter, the data is retrieved from the beginning of the day or hour specified in *ReportedStartTime*. -We recommend that you follow the next link in the response to page though the data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportedEndTime -Specifies the reported end time for when resource usage was recorded in the Azure billing system. - -Azure is a distributed system, spanning multiple datacenters around the world, so there is a delay between when the resource was actually consumed, which is the resource usage time, and when the usage event reached the billing system, which is the resource usage reported time. -In order to get all usage events for a subscription that are reported for a time period, you query by reported time. -Even though you query by reported time, the cmdlet aggregates the response data by the resource usage time. -The resource usage data is the useful pivot for analyzing the data. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportedStartTime -Specifies the reported start time for when resource usage was recorded in the Azure billing system. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowDetails -Indicates whether this cmdlet returns instance-level details with the usage data. - -The default value is $True. - -If $False, the service aggregates the results on the server side, and therefore returns fewer aggregate groups. -For example, if you are running three websites, by default you will get three line items for website consumption. -However, when the value is $False, all the data for the same **subscriptionId**, **meterId**, **usageStartTime**, and **usageEndTime** is collapsed into a single line item. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/AzureRM.Websites.md b/azurermps-2.5.0/AzureRm.Websites/AzureRM.Websites.md deleted file mode 100644 index efef3fb76c..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/AzureRM.Websites.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -Module Name: AzureRM.Websites -Module Guid: cc69c625-e961-43f4-8b50-0061eba6e4b6 -Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites -Help Version: 1.0.0.0 -Locale: en-US ---- - -# AzureRM.Websites Module -## Description -ARM (Azure Resource Manager) Web App and App Service Plan commands. - -## AzureRM.Websites Cmdlets -### [Edit-AzureRmWebAppBackupConfiguration](Edit-AzureRmWebAppBackupConfiguration.md) -Modifies an Azure Web App backup schedule. - -### [Get-AzureRmAppServicePlan](Get-AzureRmAppServicePlan.md) -Gets an Azure App Service plan in the specified resource group. - -### [Get-AzureRmAppServicePlanMetrics](Get-AzureRmAppServicePlanMetrics.md) -Gets usage metrics for an Azure Web App. - -### [Get-AzureRmWebApp](Get-AzureRmWebApp.md) -Gets Azure Web Apps in the specified resource group. - -### [Get-AzureRmWebAppBackup](Get-AzureRmWebAppBackup.md) -Gets an Azure Web App backup. - -### [Get-AzureRmWebAppBackupConfiguration](Get-AzureRmWebAppBackupConfiguration.md) -Gets an Azure Web App backup schedule. - -### [Get-AzureRmWebAppBackupList](Get-AzureRmWebAppBackupList.md) -Gets all backups of an Azure Web App. - -### [Get-AzureRmWebAppCertificate](Get-AzureRmWebAppCertificate.md) -Gets an Azure Web App certificate. - -### [Get-AzureRmWebAppMetrics](Get-AzureRmWebAppMetrics.md) -Gets Azure Web App metrics. - -### [Get-AzureRmWebAppPublishingProfile](Get-AzureRmWebAppPublishingProfile.md) -Gets an Azure Web App publishing profile. - -### [Get-AzureRmWebAppSlot](Get-AzureRmWebAppSlot.md) -Gets an Azure Web App slot. - -### [Get-AzureRmWebAppSlotConfigName](Get-AzureRmWebAppSlotConfigName.md) -Get the list of Web App Slot Config names - -### [Get-AzureRmWebAppSlotMetrics](Get-AzureRmWebAppSlotMetrics.md) -Gets metrics for an Azure Web App slot. - -### [Get-AzureRmWebAppSlotPublishingProfile](Get-AzureRmWebAppSlotPublishingProfile.md) -Gets an Azure Web App slot publishing profile. - -### [Get-AzureRmWebAppSSLBinding](Get-AzureRmWebAppSSLBinding.md) -Gets an Azure Web App certificate SSL binding. - -### [New-AzureRmAppServicePlan](New-AzureRmAppServicePlan.md) -Creates an Azure App Service plan in a given Geo location. - -### [New-AzureRmWebApp](New-AzureRmWebApp.md) -Creates an Azure Web App. - -### [New-AzureRmWebAppBackup](New-AzureRmWebAppBackup.md) -Creates an Azure Web App backup. - -### [New-AzureRmWebAppDatabaseBackupSetting](New-AzureRmWebAppDatabaseBackupSetting.md) -Creates an Azure Web App database backup setting to be used with New-AzureRmWebAppBackup. - -### [New-AzureRmWebAppSlot](New-AzureRmWebAppSlot.md) -Creates an Azure Web App slot. - -### [New-AzureRmWebAppSSLBinding](New-AzureRmWebAppSSLBinding.md) -Creates an SSL certificate binding for an Azure Web App. - -### [Remove-AzureRmAppServicePlan](Remove-AzureRmAppServicePlan.md) -Removes an Azure App Service plan. - -### [Remove-AzureRmWebApp](Remove-AzureRmWebApp.md) -Removes an Azure Web App. - -### [Remove-AzureRmWebAppBackup](Remove-AzureRmWebAppBackup.md) -Removes an Azure Web App backup. - -### [Remove-AzureRmWebAppSlot](Remove-AzureRmWebAppSlot.md) -Removes an Azure Web App slot. - -### [Remove-AzureRmWebAppSSLBinding](Remove-AzureRmWebAppSSLBinding.md) -Removes an SSL binding from an uploaded certificate. - -### [Reset-AzureRmWebAppPublishingProfile](Reset-AzureRmWebAppPublishingProfile.md) -Resets the publishing credentials of an Azure Web App. - -### [Reset-AzureRmWebAppSlotPublishingProfile](Reset-AzureRmWebAppSlotPublishingProfile.md) -Resets the publishing credentials of an Azure Web App slot. - -### [Restart-AzureRmWebApp](Restart-AzureRmWebApp.md) -Restarts an Azure Web App. - -### [Restart-AzureRmWebAppSlot](Restart-AzureRmWebAppSlot.md) -Restarts an Azure Web App slot. - -### [Restore-AzureRmWebAppBackup](Restore-AzureRmWebAppBackup.md) -Restores an Azure Web App from a backup. - -### [Set-AzureRmAppServicePlan](Set-AzureRmAppServicePlan.md) -Sets an Azure App Service plan. - -### [Set-AzureRmWebApp](Set-AzureRmWebApp.md) -Modifies an Azure Web App. - -### [Set-AzureRmWebAppSlot](Set-AzureRmWebAppSlot.md) -Modifies an Azure Web App slot. - -### [Set-AzureRmWebAppSlotConfigName](Set-AzureRmWebAppSlotConfigName.md) -Set Web App Slot Config names - -### [Start-AzureRmWebApp](Start-AzureRmWebApp.md) -Starts an Azure Web App. - -### [Start-AzureRmWebAppSlot](Start-AzureRmWebAppSlot.md) -Starts an Azure Web App slot. - -### [Stop-AzureRmWebApp](Stop-AzureRmWebApp.md) -Stops an Azure Web App. - -### [Stop-AzureRmWebAppSlot](Stop-AzureRmWebAppSlot.md) -Stops an Azure Web App slot. - -### [Switch-AzureRmWebAppSlot](Switch-AzureRmWebAppSlot.md) -Swap two slots with a Web App - diff --git a/azurermps-2.5.0/AzureRm.Websites/Edit-AzureRmWebAppBackupConfiguration.md b/azurermps-2.5.0/AzureRm.Websites/Edit-AzureRmWebAppBackupConfiguration.md deleted file mode 100644 index 060d688bed..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Edit-AzureRmWebAppBackupConfiguration.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: BFC38930-DBB4-4EBB-8E29-73B901FAF486 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/edit-azurermwebappbackupconfiguration -schema: 2.0.0 ---- - -# Edit-AzureRmWebAppBackupConfiguration - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Edit-AzureRmWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> - [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] - [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -### FromWebApp -``` -Edit-AzureRmWebAppBackupConfiguration [-FrequencyInterval] <Int32> [-FrequencyUnit] <String> - [-RetentionPeriodInDays] <Int32> [[-StartTime] <DateTime>] [-KeepAtLeastOneBackup] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> - [[-Databases] <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Edit-AzureRmWebAppBackupConfiguration** cmdlet edits the current configuration backup for an Azure Web App. - -## EXAMPLES - -## PARAMETERS - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: DatabaseBackupSetting[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -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 -``` - -### -FrequencyInterval -Frequency Interval - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FrequencyUnit -Frequency Unit - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeepAtLeastOneBackup -Keep At Least One Backup Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RetentionPeriodInDays -Retention Period In Days - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartTime -StartTime in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppBackupConfiguration](./Get-AzureRmWebAppBackupConfiguration.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlan.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlan.md deleted file mode 100644 index 1512d9bc9a..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlan.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 89ED4231-7616-47D0-BDAA-D849C245DC79 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermappserviceplan -schema: 2.0.0 ---- - -# Get-AzureRmAppServicePlan - -## SYNOPSIS -Gets an Azure App Service plan in the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmAppServicePlan [[-ResourceGroupName] <String>] [[-Name] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmAppServicePlan [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAppServicePlan** cmdlet gets an Azure App Service plan in the specified resource group. - -## EXAMPLES - -### Example 1: Get an App Service plan from a resource group -``` -PS C:\>Get-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command gets the App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. - -### Example 2: Get all App Service plans in a location -``` -PS C:\>Get-AzureRmAppServicePlan -Location "West US" -``` - -This command gets all App Service plans located in the "West US" region. - -## 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 -Location - -```yaml -Type: String -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ServerFarmWithRichSku - -### Microsoft.Azure.Management.WebSites.Models.ServerFarmCollection - -## NOTES - -## RELATED LINKS - -[New-AzureRmAppServicePlan](./New-AzureRmAppServicePlan.md) - -[Remove-AzureRmAppServicePlan](./Remove-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlanMetrics.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlanMetrics.md deleted file mode 100644 index b438bdaa2d..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmAppServicePlanMetrics.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 0AC0C4F9-4138-49EA-88CB-DC220DE7E9F4 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermappserviceplanmetrics -schema: 2.0.0 ---- - -# Get-AzureRmAppServicePlanMetrics - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmAppServicePlanMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmAppServicePlanMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-AppServicePlan] <AppServicePlan> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmAppServicePlanMetrics** gets App Service Plan metrics. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoAppServPlan" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics ["CPU Percentage"] -``` - -This command gets CPU percentage of the App Service Plan - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: AppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -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 -End Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: PT1M, PT1H, P1D - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ServerFarmWithRichSku -Parameter 'AppServicePlan' accepts value of type 'ServerFarmWithRichSku' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebApp.md deleted file mode 100644 index f3dd2a0a1e..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebApp.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: A87ED954-9C09-4329-A005-ABFF36C45E6E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebapp -schema: 2.0.0 ---- - -# Get-AzureRmWebApp - -## SYNOPSIS -Gets Azure Web Apps in the specified resource group. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebApp [[-ResourceGroupName] <String>] [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebApp [-AppServicePlan] <AppServicePlan> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S3 -``` -Get-AzureRmWebApp [-Location] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebApp** cmdlet gets information about an Azure Web App. - -## EXAMPLES - -### Example 1: Get a Web App from a resource group -``` -PS C:\>Get-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command gets the Web App named ContosoSite that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -AppServicePlan -App Service Plan object - -```yaml -Type: AppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: String -Parameter Sets: S3 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackup.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackup.md deleted file mode 100644 index 57b26c19da..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackup.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: EAAF615B-6139-438B-A2FD-6966E72B3AA9 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackup -schema: 2.0.0 ---- - -# Get-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackup [-BackupId] <String> [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackup** cmdlet gets the specified backup of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" -``` - -This command gets the backup with ID "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -BackupId -Backup Id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 -Webapp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -Piped WebApp - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupConfiguration.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupConfiguration.md deleted file mode 100644 index 1bd1e96607..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupConfiguration.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 8337BEA9-4927-4718-83B9-F3F567BE0FBD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackupconfiguration -schema: 2.0.0 ---- - -# Get-AzureRmWebAppBackupConfiguration - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackupConfiguration [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackupConfiguration [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackupConfiguration** cmdlet gets the backup configuration of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackupConfiguration -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -``` - -This command gets the backup configuration from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Name - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackupConfiguration - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupList.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupList.md deleted file mode 100644 index 9d4e9e99e4..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppBackupList.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: BBC85035-DCF7-44FA-A747-A1563A55B820 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappbackuplist -schema: 2.0.0 ---- - -# Get-AzureRmWebAppBackupList - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppBackupList [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppBackupList [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppBackupList** cmdlet gets a list of backups for an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppBackupList -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -``` - -This command returns a backup list pertaining to WebApp WebAppStandard associated with the resource group ContosoResourceGroup. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -Slot name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -Piped WebApp - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup[] - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppCertificate.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppCertificate.md deleted file mode 100644 index bca8a2b09b..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppCertificate.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 2D83D38F-3A5C-40DB-BE8B-D52E5CAFCF6E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappcertificate -schema: 2.0.0 ---- - -# Get-AzureRmWebAppCertificate - -## SYNOPSIS -Gets an Azure Web App certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -Get-AzureRmWebAppCertificate [[-ResourceGroupName] <String>] [[-Thumbprint] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppCertificate** cmdlet gets information about Azure Web App certificates associated with a specified resource group. -If you know the certificate thumbprint you can also use this cmdlet to get information about a specified certificate. - -## EXAMPLES - -### Example 1: Get Web App certificates in a resource group -``` -PS C:\>Get-AzureRmWebAppCertificate -ResourceGroupName "ContosoResourceGroup" -``` - -This command returns information about the uploaded Web App certificates associated with the resource group ContosoResourceGroup. - -### Example 2: Get a specified web app certificate -``` -PS C:\>Get-AzureRmWebAppCertificate -ResourceGroupName "ContosoResourceGroup" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -``` - -This command gets the ContosoResourceGroup Web App certificate with the thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3. - -## 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 the certificate is assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier for the certificate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppMetrics.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppMetrics.md deleted file mode 100644 index 0b35d52115..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppMetrics.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 513BE097-EB4A-4C49-9F7F-42A2BED09022 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappmetrics -schema: 2.0.0 ---- - -# Get-AzureRmWebAppMetrics - -## SYNOPSIS -Gets Azure Web App metrics. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppMetrics** gets Web App metrics. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics ["Requests"] -``` - -This command gets Requests of the Web App ContosoWebApp - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## 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 -``` - -### -EndTime -End Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: PT1M, PT1H, P1D - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics as a string array - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppCertificate](./Get-AzureRmWebAppCertificate.md) - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppPublishingProfile.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppPublishingProfile.md deleted file mode 100644 index f9610a132c..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppPublishingProfile.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 38433470-CAFD-4B8F-980C-63D4B264B39F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebapppublishingprofile -schema: 2.0.0 ---- - -# Get-AzureRmWebAppPublishingProfile - -## SYNOPSIS -Gets an Azure Web App publishing profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppPublishingProfile** cmdlet gets an Azure Web App publishing profile. - -## EXAMPLES - -### 1: -``` -PS C:\> Get-AzureRmWebAppPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile" -``` - -This command gets the publishing profile in Ftp format for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - and stores it in the specified output file. - -## 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 -``` - -### -Format -Format - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WebDeploy, FileZilla3, Ftp - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Output File - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSSLBinding.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSSLBinding.md deleted file mode 100644 index 723a38791f..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: EE3D2BA0-32E7-4A37-BCAF-F0E8FAAC43CE -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappsslbinding -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSSLBinding - -## SYNOPSIS -Gets an Azure Web App certificate SSL binding. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSSLBinding [[-Name] <String>] [-ResourceGroupName] <String> [-WebAppName] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSSLBinding [[-Name] <String>] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSSLBinding** cmdlet gets a Secure Sockets Layer (SSL) binding for an Azure Web App. -SSL bindings are used to associate a Web App with an uploaded certificate. -Web Apps can be bound to multiple certificates. - -## EXAMPLES - -### Example 1: Get SSL bindings for a Web App -``` -PS C:\>Get-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -``` - -This command retrieves the SSL bindings for the Web App ContosoWebApp, which is associated with the resource group ContosoResourceGroup. - -### Example 2: Use an object reference to get SSL bindings for a Web App -``` -PS C:\>$WebApp = Get-AzureRmWebApp -Name "ContosoWebApp" -PS C:\> Get-AzureRmWebAppSSLBinding -WebApp $WebApp -``` - -The commands in this example also get the SSL bindings for the Web App ContosoWebApp; in this case, however, an object reference is used instead of the Web App name and the name of the associated resource group. -This object reference is created by the first command in the example, which uses **Get-AzureRmWebApp** to create an object reference to the Web App named ContosoWebApp. -That object reference is stored in a variable named $WebApp. - -This variable, and the **Get-AzureRmWebAppSSLBinding** cmdlet, are then used by the second command to get the SSL bindings. - -## 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 -Specifies the name of the SSL binding. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. - -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies a Web App deployment slot. -To get a deployment slot, use the Get-AzureRMWebAppSlot cmdlet. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App that this cmdlet gets SSL bindings from. - -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRmWebAppSSLBinding](./New-AzureRmWebAppSSLBinding.md) - -[Remove-AzureRmWebAppSSLBinding](./Remove-AzureRmWebAppSSLBinding.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlot.md deleted file mode 100644 index e9e7472da6..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlot.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 100A5980-31E2-41F9-84D4-2F5F0CB78B8A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslot -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSlot - -## SYNOPSIS -Gets an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlot [[-Slot] <String>] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlot** cmdlet gets information about an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -Slot "Slot001" -``` - -This command gets the slot named Slot001 from the Web App named WebAppStandard that belongs to the -resource group Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotConfigName.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotConfigName.md deleted file mode 100644 index e6ef5ae425..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotConfigName.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: EF2D377C-C000-4BCA-8EB9-58C805FA5C31 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotconfigname -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSlotConfigName - -## SYNOPSIS -Get the list of Web App Slot Config names - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotConfigName [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotConfigName [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotConfigName** cmdlet retrieves the list of App Setting and Connection String names that are currently marked as slot settings - -## EXAMPLES - -### 1: -``` -PS C:\>Get-AzureRmWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command gets App Settings and Connection strings pertaining to the Web App named ContosoSite associated with the resource group Default-Web-WestUS - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotMetrics.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotMetrics.md deleted file mode 100644 index 87f0403f98..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotMetrics.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 3BCEADF3-15DC-4033-A94A-4C8B4F5E7340 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotmetrics -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSlotMetrics - -## SYNOPSIS -Gets metrics for an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotMetrics [-Metrics] <String[]> [-StartTime] <DateTime> [[-EndTime] <DateTime>] - [-Granularity] <String> [-InstanceDetails] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotMetrics** gets Web App metrics for the specified slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmAppServicePlanMetrics -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StartTime 2016-11-30T22:00:00Z -EndTime 2016-11-30T22:30:00Z -Granularity PT1M -Metrics ["Requests"] -``` - -This command gets Request of the specified Web App - per minute(PT1M - Poll Time 1 minute) between StartTime and EndTime - -## 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 -``` - -### -EndTime -End Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Granularity -Granularity - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstanceDetails -Instance Details - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Metrics -Metrics - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Start Time in UTC - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRMAppServicePlanMetrics](./Get-AzureRmAppServicePlanMetrics.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotPublishingProfile.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotPublishingProfile.md deleted file mode 100644 index 4cdede0dd5..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSlotPublishingProfile.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: B2FDB54F-0318-4037-BC1D-6113E77DDE7E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappslotpublishingprofile -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSlotPublishingProfile - -## SYNOPSIS -Gets an Azure Web App slot publishing profile. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Get-AzureRmWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] - [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Get-AzureRmWebAppSlotPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSlotPublishingProfile** cmdlet gets the Web App publishing profile for the specified slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" -Format "Ftp" -OutputFile "C:\Users\contoso\outputfile" -``` - -This command gets the publishing profile in Ftp format for slot Slot001 pertaining to the Web App ContosoWebApp associated with the resource group Default-Web-WestUS - and stores it in the specified output file. - -## 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 -``` - -### -Format -Format - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WebDeploy, FileZilla3, Ftp - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputFile -Output File - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Reset-AzureRMWebAppSlotPublishingProfile](./Reset-AzureRmWebAppSlotPublishingProfile.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSnapshot.md b/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSnapshot.md deleted file mode 100644 index ee613f5d95..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Get-AzureRmWebAppSnapshot.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/get-azurermwebappsnapshot -schema: 2.0.0 ---- - -# Get-AzureRmWebAppSnapshot - -## SYNOPSIS -Gets the snapshots available for a web app. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Get-AzureRmWebAppSnapshot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] -``` - -### FromWebApp -``` -Get-AzureRmWebAppSnapshot [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] -``` - -## DESCRIPTION -The **Get-AzureRmWebAppSnapshot** cmdlet returns all snapshots for a web app. Snapshots are automatic backups of a web app's files and settings. A snapshot can be restored with the **Restore-AzureRmWebAppSnapshot** cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging" -``` - -Get the snapshots for a web app named "ConstosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource 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 -``` - -### -Name -The name of the web app. - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -The name of the web app slot. - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String -Microsoft.Azure.Management.WebSites.Models.Site - - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot - - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmAppServicePlan.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmAppServicePlan.md deleted file mode 100644 index 72e7cec04c..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmAppServicePlan.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM -ms.assetid: 8F36244D-A4D7-40BB-AC4C-E9AD445549F8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermappserviceplan -schema: 2.0.0 ---- - -# New-AzureRmAppServicePlan - -## SYNOPSIS -Creates an Azure App Service plan in a given Geo location. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -New-AzureRmAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [-PerSiteScaling <Boolean>] - [-ResourceGroupName] <String> [-Name] <String> [-AsJob][-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -New-AzureRmAppServicePlan [-Location] <String> [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [-PerSiteScaling <Boolean>] - [-AppServicePlan] <ServerFarmWithRichSku> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmAppServicePlan** cmdlet creates an Azure App Service plan in a given Geo location with the specified Tier, worker size, and number of workers. - -## EXAMPLES - -### Example 1: Create an App Service plan -``` -PS C:\>New-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -Location "West US" -Tier "Basic" -NumberofWorkers 2 -WorkerSize "Small" -``` - -This command creates an App Service plan named ContosoASP in the resource group named Default-Web-WestUS in Geo location West US. -The command specifies a Basic Tier and allocates two small workers. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: ServerFarmWithRichSku -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberofWorkers -Number Of Workers - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerSiteScaling -Whether or not to enable Per Site Scaling - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Tier - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Free, Shared, Basic, Standard, Premium, PremiumV2 - -Required: False -Position: 3 -Default value: Free -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerSize -Size of web worker - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Small, Medium, Large, ExtraLarge - -Required: False -Position: 5 -Default value: Small -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ServerFarmWithRichSku -Parameter 'AppServicePlan' accepts value of type 'ServerFarmWithRichSku' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ServerFarmWithRichSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Remove-AzureRmAppServicePlan](./Remove-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebApp.md deleted file mode 100644 index 0b2212c8df..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebApp.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: D6D4E733-31AE-4ABE-8C78-583EC48C56B8 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebapp -schema: 2.0.0 ---- - -# New-AzureRmWebApp - -## SYNOPSIS -Creates an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### SimpleParameterSet (Default) -``` -New-AzureRmWebApp [[-ResourceGroupName] <String>] [-Name] <String> [[-Location] <String>] - [[-AppServicePlan] <String>] [-AsJob] [-GitRepositoryPath <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### WebAppParameterSet -``` -New-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> - [[-AppServicePlan] <String>] [-SourceWebApp] <Site> [[-TrafficManagerProfile] <String>] [-IgnoreSourceControl] - [-IgnoreCustomHostNames] [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] - [[-AseResourceGroupName] <String>] [-IncludeSourceWebAppSlots] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebApp** cmdlet creates an Azure Web App in a given a resource group that uses the specified App Service plan and data center. - -## EXAMPLES - -### Example 1: Create a Web App -``` -PS C:\>New-AzureRmWebApp -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -Location "West US" -AppServicePlan "ContosoServicePlan" -``` - -This command creates an Azure Web App named ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. -The command uses an existing App Service plan named ContosoServicePlan. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettingsOverrides -App Settings Overrides HashTable - -```yaml -Type: Hashtable -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitRepositoryPath -Path to the GitHub repository containign the web application to deploy. - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreCustomHostNames -Ignore Custom Host Names Option - -```yaml -Type: SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSourceControl -Ignore Source Control Option - -```yaml -Type: SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeSourceWebAppSlots -Include Source WebApp Slots Option - -```yaml -Type: SwitchParameter -Parameter Sets: WebAppParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Location - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: WebAppName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: SimpleParameterSet -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: WebAppParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceWebApp -Source WebApp Object - -```yaml -Type: Site -Parameter Sets: WebAppParameterSet -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TrafficManagerProfile -Resource Id of existing traffic manager profile - -```yaml -Type: String -Parameter Sets: WebAppParameterSet -Aliases: TrafficManagerProfileName, TrafficManagerProfileId - -Required: False -Position: 5 -Default value: None -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'SourceWebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.Site - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppBackup.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppBackup.md deleted file mode 100644 index 90a9afde2a..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppBackup.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: D3FE0440-C663-4379-8F5F-2E66EF024E5D -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappbackup -schema: 2.0.0 ---- - -# New-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -New-AzureRmWebAppBackup [[-BackupName] <String>] [-ResourceGroupName] <String> [-Name] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> - [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -### FromWebApp -``` -New-AzureRmWebAppBackup [[-BackupName] <String>] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [-Databases <DatabaseBackupSetting[]>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppBackup** cmdlet creates an Azure Web App Backup. - -## EXAMPLES - -### 1: -``` -PS C:\> New-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -``` - -Creates a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in https://storageaccount.file.core.windows.net - -## PARAMETERS - -### -BackupName -Backup Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: DatabaseBackupSetting[] -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. - -```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 -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps.AzureWebAppBackup - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppDatabaseBackupSetting.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppDatabaseBackupSetting.md deleted file mode 100644 index d29b22f8f0..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppDatabaseBackupSetting.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 22ACB910-0C41-4649-8D22-537E38CB4570 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappdatabasebackupsetting -schema: 2.0.0 ---- - -# New-AzureRmWebAppDatabaseBackupSetting - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmWebAppDatabaseBackupSetting [-Name] <String> [-DatabaseType] <String> [-ConnectionString] <String> - [[-ConnectionStringName] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppDatabaseBackupSetting** cmdlet creates a new Azure Web App Backup setting. - -## EXAMPLES - -### 1: -``` -PS C:\> New-AzureRmWebAppDatabaseBackupSetting -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -ConnectionString "MyConnectionString" -DatabaseType "SqlAzure" -``` - -Creates a database backup setting (connection string) of type SqlAzure for the specified app ContosoWebApp that is within resource group Default-Web-WestUS. - -## PARAMETERS - -### -ConnectionString -Connection String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionStringName -Connection String Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseType -Database Type ( e.g. "SqlAzure" or "MySql" ) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -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 -WebApp Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.DatabaseBackupSetting - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSSLBinding.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSSLBinding.md deleted file mode 100644 index f8e39cb40a..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 910239BE-9E48-4DC5-85EA-CC6D466FE62F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappsslbinding -schema: 2.0.0 ---- - -# New-AzureRmWebAppSSLBinding - -## SYNOPSIS -Creates an SSL certificate binding for an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -New-AzureRmWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-Name] <String> [[-SslState] <SslState>] [-CertificateFilePath] <String> [-CertificatePassword] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -New-AzureRmWebAppSSLBinding [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-Name] <String> [[-SslState] <SslState>] [-Thumbprint] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S3 -``` -New-AzureRmWebAppSSLBinding [-WebApp] <Site> [-Name] <String> [[-SslState] <SslState>] - [-CertificateFilePath] <String> [-CertificatePassword] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S4 -``` -New-AzureRmWebAppSSLBinding [-WebApp] <Site> [-Name] <String> [[-SslState] <SslState>] [-Thumbprint] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppSSLBinding** cmdlet creates a Secure Socket Layer (SSL) certificate binding for an Azure Web App. -The cmdlet creates an SSL binding in two ways: - -- You can bind a Web App to an existing certificate. -- You can upload a new certificate and then bind the Web App to this new certificate. - -Regardless of which approach you use, the certificate and the Web App must be associated with the same Azure resource group. -If you have a Web App in Resource Group A and you want to bind that Web App to a certificate in Resource Group B, the only way to do that is to upload a copy of the certificate to Resource Group A. - -If you upload a new certificate, keep in mind the following requirements for an Azure SSL certificate: - -- The certificate must contain a private key. -- The certificate must use the Personal Information Exchange (PFX) format. -- The certificate's subject name must match the domain used to access the Web App. -- The certificate must use a minimum of 2048-bit encryption. - -## EXAMPLES - -### Example 1: Bind a certificate to a Web App -``` -PS C:\>New-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" -Name "www.contoso.com" -``` - -This command binds an existing Azure certificate (a certificate with the Thumbprint E3A38EBA60CAA1C162785A2E1C44A15AD450199C3) to the web app named ContosoWebApp. - -## PARAMETERS - -### -CertificateFilePath -Specifies the file path for the certificate to be uploaded. - -The *CertificateFilePath* parameter is only required if the certificate has not yet been uploaded to Azure. - -```yaml -Type: String -Parameter Sets: S1, S3 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePassword -Specifies the decryption password for the certificate. - -```yaml -Type: String -Parameter Sets: S1, S3 -Aliases: - -Required: True -Position: 5 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Web App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. - -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1, S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies the name of the Web App deployment slot. -You can use the Get-AzureRMWebAppSlot cmdlet to get a slot. - -Deployment slots provide a way for you to stage and validate web apps without those apps being accessible over the Internet. -Typically you will deploy your changes to a staging site, validate those changes, and then deploy to the production (Internet-accessible) site. - -```yaml -Type: String -Parameter Sets: S1, S2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SslState -Specifies whether the certificate is enabled. -Set the *SSLState* parameter to 1 to enable the certificate, or set *SSLState* to 0 to disable the certificate. - -```yaml -Type: SslState -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, SniEnabled, IpBasedEnabled - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the unique identifier for the certificate. - -```yaml -Type: String -Parameter Sets: S2, S4 -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. - -You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. - -```yaml -Type: Site -Parameter Sets: S3, S4 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App for which the new SSL binding is being created. - -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1, S2 -Aliases: - -Required: True -Position: 1 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - -[Remove-AzureRmWebAppSSLBinding](./Remove-AzureRmWebAppSSLBinding.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSlot.md deleted file mode 100644 index beb6c70148..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/New-AzureRmWebAppSlot.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: D23BBF34-80C0-48B1-8E1C-6F345DEC61AD -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/new-azurermwebappslot -schema: 2.0.0 ---- - -# New-AzureRmWebAppSlot - -## SYNOPSIS -Creates an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -``` -New-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [[-AppServicePlan] <String>] [[-SourceWebApp] <Site>] [-IgnoreSourceControl] [-IgnoreCustomHostNames] - [[-AppSettingsOverrides] <Hashtable>] [[-AseName] <String>] [[-AseResourceGroupName] <String>] [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **New-AzureRmWebAppSlot** cmdlet creates an Azure Web App Slot in a given a resource group that uses the specified App Service plan and data center. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-AzureRmWebAppSlot -ResourceGroupName Default-Web-WestUS -Name "ContosoSite" -AppServicePlan "ContosoServicePlan" -Slot "Slot001" -``` - -This command creates a Slot named Slot001 under an existing Web App names ContosoSite in the existing resource group named Default-Web-WestUS in data center West US. -The command uses an existing App Service plan named ContosoServicePlan. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettingsOverrides -App Settings Overrides Hashtable - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseName -App Service Environment Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AseResourceGroupName -App Service Environment Resource Group Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreCustomHostNames -Ignore Custom HostNames Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreSourceControl -Ignore Source Control Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Webapp Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Webapp Slot Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceWebApp -Source WebApp Object - -```yaml -Type: Site -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'SourceWebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmAppServicePlan.md b/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmAppServicePlan.md deleted file mode 100644 index f743e5efa3..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmAppServicePlan.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 78AAF476-2E9E-4E60-9940-9A9AC6F9506A -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermappserviceplan -schema: 2.0.0 ---- - -# Remove-AzureRmAppServicePlan - -## SYNOPSIS -Removes an Azure App Service plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmAppServicePlan [-Force] [-ResourceGroupName] <String> [-Name] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmAppServicePlan [-Force] [-AppServicePlan] <AppServicePlan> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmAppServicePlan** cmdlet removes an Azure App Service plan. - -## EXAMPLES - -### Example 1: Remove an App Service plan -``` -PS C:\>Remove-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -``` - -This command removes the Azure App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: AppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -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 -Forcefully Remove Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -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: False -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ServerFarmWithRichSku -Parameter 'AppServicePlan' accepts value of type 'ServerFarmWithRichSku' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) - -[New-AzureRmAppServicePlan](./New-AzureRmAppServicePlan.md) - -[Set-AzureRmAppServicePlan](./Set-AzureRmAppServicePlan.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebApp.md deleted file mode 100644 index c92ed59bf3..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebApp.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 9057185C-6F22-4C4A-8480-BE542B5D6BAF -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebapp -schema: 2.0.0 ---- - -# Remove-AzureRmWebApp - -## SYNOPSIS -Removes an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebApp [-Force] [-ResourceGroupName] <String> [-Name] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebApp [-Force] [-WebApp] <Site> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebApp** cmdlet removes an Azure Web App provided the resource group and Web App name. -This cmdlet, by default, also removes all slots and metrics. - -## EXAMPLES - -### Example 1: Remove a Web App -``` -PS C:\>Remove-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command removes the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS. - -## 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 -Forcefully Remove Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppBackup.md b/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppBackup.md deleted file mode 100644 index 79ae581cab..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppBackup.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 65A78654-A490-4B60-8C16-B0CC597EE995 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappbackup -schema: 2.0.0 ---- - -# Remove-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Remove-AzureRmWebAppBackup [-BackupId] <String> [-ResourceGroupName] <String> [-Name] <String> - [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### FromWebApp -``` -Remove-AzureRmWebAppBackup [-BackupId] <String> [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppBackup** cmdlet removes the specified backup of an Azure Web App. - -## EXAMPLES - -### 1: -``` -PS C:\>Remove-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "WebAppStandard" -BackupId "12345" -``` - -This command removes the backup with backup with ID of "12345" from the Web App named WebAppStandard that belongs to the resource group Default-Web-WestUS. - -## PARAMETERS - -### -BackupId -Backup Id - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -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 -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.BackupItem - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSSLBinding.md b/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSSLBinding.md deleted file mode 100644 index 2a49b72104..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSSLBinding.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 3AB3D398-E5DB-4214-BA27-6E3B7D225550 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappsslbinding -schema: 2.0.0 ---- - -# Remove-AzureRmWebAppSSLBinding - -## SYNOPSIS -Removes an SSL binding from an uploaded certificate. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] - [-ResourceGroupName] <String> [-WebAppName] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebAppSSLBinding [-Name] <String> [[-DeleteCertificate] <Boolean>] [-Force] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppSSLBinding** cmdlet removes a Secure Sockets Layer (SSL) binding from an Azure Web App. -SSL bindings are used to associate a Web App with a certificate. - -## EXAMPLES - -### Example 1: Remove an SSL binding for a web app -``` -PS C:\>Remove-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" -``` - -This command removes the SSL binding for the web app ContosoWebApp. -Since the *DeleteCertificate* parameter is not included, the certificate will be deleted if it no longer has any SSL bindings. - -### Example 2: Remove an SSL binding without removing the certificate -``` -PS C:\>Remove-AzureRmWebAppSSLBinding -ResourceGroupName "ContosoResourceGroup" -WebAppName "ContosoWebApp" -Name "www.contoso.com" -DeleteCertificate $False -``` - -Similar to Example 1, this command also removes the SSL binding for the Web App ContosoWebApp. -In this case, however, the *DeleteCertificate* parameter is included, and the parameter value is set to $False. -That means that the certificate will not be deleted regardless of whether it has any SSL bindings or not. - -### Example 3: Use an object reference to remove an SSL binding -``` -PS C:\>$WebApp = Get-AzureRmWebApp -Name "ContosoWebApp" -PS C:\> Remove-AzureRmWebAppSSLBinding -WebApp $WebApp -Name "www.contoso.com" -``` - -This example uses an object reference to the Web App website to remove the SSL binding for a Web App. - -The first command uses the Get-AzureRmWebApp cmdlet to create an object reference to the Web App named ContosoWebApp. -That object reference is stored in a variable named $WebApp. - -The second command uses the object reference and the **Remove-AzureRmWebAppSSLBinding** cmdlet to remove the SSL binding. - -## 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 -``` - -### -DeleteCertificate -Specifies the action to take place if the SSL binding being removed is the only binding used by the certificate. -If *DeleteCertificate* is set to $False, the certificate will not be deleted when the binding is deleted. -If *DeleteCertificate* is set to $True or is not included in the command, the certificate will be deleted along with the SSL binding. - -The certificate will only be deleted if the SSL binding being removed is the only binding used by the certificate. -If the certificate has more than one binding, the certificate will not be removed regardless of the value of the *DeleteCertificate* parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Web App. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the name of the resource group that the certificate is assigned to. - -You cannot use the *ResourceGroupName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -Specifies the Web App deployment slot. -To get a deployment slot, use the Get-AzureRMWebAppSlot cmdlet. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -Specifies a Web App. -To get a Web App, use the Get-AzureRmWebApp cmdlet. - -You cannot use the *WebApp* parameter in the same command as the *ResourceGroupName* parameter and/or the *WebAppName*. - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebAppName -Specifies the name of the Web App. - -You cannot use the *WebAppName* parameter and the *WebApp* parameter in the same command. - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -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: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.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: False -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebAppSSLBinding](./Get-AzureRmWebAppSSLBinding.md) - -[New-AzureRmWebAppSSLBinding](./New-AzureRmWebAppSSLBinding.md) - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSlot.md deleted file mode 100644 index 37b8860f1a..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Remove-AzureRmWebAppSlot.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/remove-azurermwebappslot -schema: 2.0.0 ---- - -# Remove-AzureRmWebAppSlot - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Remove-AzureRmWebAppSlot [-Force] [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Remove-AzureRmWebAppSlot [-Force] [-WebApp] <Site> [-AsJob][-DefaultProfile <IAzureContextContainer>] [-WhatIf] - [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Remove-AzureRmWebAppSlot** cmdlet removes an Azure Web App Slot provided the resource group and Web App name. -This cmdlet, by default, also removes all slots and metrics. - -## EXAMPLES - -### Example 1: Remove a Web App Slot -``` -PS C:\>Remove-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -Slot "Slot001" -``` - -This command removes the Slot named Slot001 associated with Web App ContosoSite that belongs to the resource group named Default-Web-WestUS. - -## 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 -Forcefully Remove Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 -``` -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.AzureOperationResponse - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppPublishingProfile.md b/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppPublishingProfile.md deleted file mode 100644 index ef754bb86e..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppPublishingProfile.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 84C861B2-DCB3-47F0-8589-BB3172C6E1EC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/reset-azurermwebapppublishingprofile -schema: 2.0.0 ---- - -# Reset-AzureRmWebAppPublishingProfile - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Reset-AzureRmWebAppPublishingProfile [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Reset-AzureRmWebAppPublishingProfile [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmWebAppPublishingProfile** cmdlet resets the publishing profile for the specified Web App. - -## EXAMPLES - -### 1: -``` -PS C:\> Reset-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command resets the publishing profile for the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md b/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md deleted file mode 100644 index 07fa97bf30..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Reset-AzureRmWebAppSlotPublishingProfile.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 3CD449A1-084E-4950-80EF-06B5ECDFB70F -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/reset-azurermwebappslotpublishingprofile -schema: 2.0.0 ---- - -# Reset-AzureRmWebAppSlotPublishingProfile - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Reset-AzureRmWebAppSlotPublishingProfile [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Reset-AzureRmWebAppSlotPublishingProfile [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Reset-AzureRmWebAppSlotPublishingProfile** cmdlet resets the publishing profile for the specified Web App Slot. - -## EXAMPLES - -### 1: -``` -PS C:\> Reset-AzureRmWebAppSlotPublishingProfile -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "slot001" -``` - -This command resets the publishing profile for the Slot named slot001 for the Web App ContosoWebApp associated with the resource group Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebApp.md deleted file mode 100644 index 095a8ab276..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebApp.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 297071E5-FC06-4493-BCC2-37D4929E4025 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restart-azurermwebapp -schema: 2.0.0 ---- - -# Restart-AzureRmWebApp - -## SYNOPSIS -Restarts an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Restart-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Restart-AzureRmWebApp [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmWebApp** cmdlet stops and then starts an Azure Web App. -If the Web App is in a stopped state, use the Start-AzureRmWebApp cmdlet. - -## EXAMPLES - -### Example 1: Restart a Web App -``` -PS C:\>Restart-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite" -``` - -This command stops the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS and then restarts it. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebAppSlot.md deleted file mode 100644 index 474e936be2..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Restart-AzureRmWebAppSlot.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 645E74D2-640D-494F-9798-4375FE6A0AF2 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restart-azurermwebappslot -schema: 2.0.0 ---- - -# Restart-AzureRmWebAppSlot - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Restart-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Restart-AzureRmWebAppSlot [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restart-AzureRmWebAppSlot** cmdlet stops and then starts an Azure Web App Slot. -If the Web App Slot is in a stopped state, use the Start-AzureRmWebAppSlot cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Restart-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command restarts the slot Slot001 for the web app ContosoWebApp associated with the resource group Default-Web-WestUS - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppBackup.md b/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppBackup.md deleted file mode 100644 index ea01e6addd..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppBackup.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: DC400E32-CAB9-4354-99B2-ABA4AA776030 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restore-azurermwebappbackup -schema: 2.0.0 ---- - -# Restore-AzureRmWebAppBackup - -## SYNOPSIS - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Restore-AzureRmWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] - [-IgnoreConflictingHostNames] [-ResourceGroupName] <String> [-Name] <String> [[-Slot] <String>] - [-DefaultProfile <IAzureContextContainer>] [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] - [<CommonParameters>] -``` - -### FromWebApp -``` -Restore-AzureRmWebAppBackup [-AppServicePlan <String>] [-Databases <DatabaseBackupSetting[]>] - [-IgnoreConflictingHostNames] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [-StorageAccountUrl] <String> [-BlobName] <String> [-Overwrite] [<CommonParameters>] -``` - -## DESCRIPTION -The **Restore-AzureRmWebAppBackup** cmdlet restores an Azure Web App Backup. - -## EXAMPLES - -### 1: -``` -PS C:\> Restore-AzureRmWebAppBackup -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -StorageAccountUrl "https://storageaccount.file.core.windows.net" -BlobName "myBlob" -``` - -Restores a backup of the specified app ContosoWebApp that is within resource group Default-Web-WestUS in blob "myBlob" located at https://storageaccount.file.core.windows.net - -## PARAMETERS - -### -AppServicePlan -The name of the App Service Plan for the restored app. If left empty, the app's current App Service Plan is used. -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BlobName -Blob Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Databases -Databases of type DatabaseBackupSetting[] - -```yaml -Type: DatabaseBackupSetting[] -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. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreConflictingHostNames -Ignore Conflicting HostNames Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Overwrite -Overwrite Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StorageAccountUrl -Storage Account Url - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppSnapshot.md b/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppSnapshot.md deleted file mode 100644 index fe5626a9e9..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Restore-AzureRmWebAppSnapshot.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/restore-azurermwebappsnapshot -schema: 2.0.0 ---- - -# Restore-AzureRmWebAppSnapshot - -## SYNOPSIS -Restores a web app snapshot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### FromResourceName -``` -Restore-AzureRmWebAppSnapshot [-RecoverConfiguration] [-Force] [-AsJob] [-ResourceGroupName] <String> - [-Name] <String> [[-Slot] <String>] [-DefaultProfile <IAzureContextContainer>] - [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### FromWebApp -``` -Restore-AzureRmWebAppSnapshot [-RecoverConfiguration] [-Force] [-AsJob] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [-InputObject] <AzureWebAppSnapshot> [-WhatIf] [-Confirm] - [<CommonParameters>] -``` - -## DESCRIPTION -Restores a web app snapshot to the web app. Restoring a snapshot overwrites all files in a web app with the files contained in the snapshot. To restore settings as well, use the RecoverConfiguration switch parameter. A snapshot from one web app can be restored to any other web app in the same subscription. - -## EXAMPLES - -### Example 1 -``` -PS C:\> $snapshot = (Get-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Staging")[0] -PS C:\> Restore-AzureRmWebAppSnapshot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoApp" -Slot "Restore" -InputObject $snapshot -RecoverConfiguration -``` - -Gets the latest snapshot of a web app named "ContosoApp" with a slot named "Staging" in the "Default-Web-WestUS" resource group. Restores the snapshot to the web app's "Restore" slot. - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: IAzureContextContainer -Parameter Sets: (All) -Aliases: AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Allows the original web app to be overwritten without displaying a warning. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -The Azure Web App snapshot. -```yaml -Type: AzureWebAppSnapshot -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the web app. -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoverConfiguration -Recover the web app's configuration in addition to files. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Slot -The name of the web app slot. -```yaml -Type: String -Parameter Sets: FromResourceName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebApp -The web app object -```yaml -Type: Site -Parameter Sets: FromWebApp -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.SwitchParameter -Microsoft.Azure.Management.WebSites.Models.Site -System.String -Microsoft.Azure.Commands.WebApps.Cmdlets.BackupRestore.AzureWebAppSnapshot -System.DateTime - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmAppServicePlan.md b/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmAppServicePlan.md deleted file mode 100644 index 85cb2a7b43..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmAppServicePlan.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 32D45795-FBCD-4157-BF45-41BD1F61782E -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermappserviceplan -schema: 2.0.0 ---- - -# Set-AzureRmAppServicePlan - -## SYNOPSIS -Sets an Azure App Service plan. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmAppServicePlan [[-AdminSiteName] <String>] [[-Tier] <String>] [[-NumberofWorkers] <Int32>] - [[-WorkerSize] <String>] [-PerSiteScaling <Boolean>] [-ResourceGroupName] <String> [-Name] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmAppServicePlan [-AppServicePlan] <AppServicePlan> [-AsJob] -[-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmAppServicePlan** cmdlet sets an Azure App Service plan. - -## EXAMPLES - -### 1: Modify an App Service plan -``` -PS C:\>Set-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PerSiteScaling $true -``` - -This command sets the PerSiteScaling option to true on the App Service plan named ContosoASP - that belongs to the resource group named Default-Web-WestUS. - -## PARAMETERS - -### -AdminSiteName -Admin Site Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppServicePlan -App Service Plan Object - -```yaml -Type: AppServicePlan -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -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 -``` - -### -Name -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberofWorkers -Number Of Workers - -```yaml -Type: Int32 -Parameter Sets: S1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerSiteScaling -Per Site Scaling Boolean - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tier -Tier - -```yaml -Type: String -Parameter Sets: S1 -Aliases: -Accepted values: Free, Shared, Basic, Standard, Premium, PremiumV2 - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkerSize -Worker Size - -```yaml -Type: String -Parameter Sets: S1 -Aliases: -Accepted values: Small, Medium, Large, ExtraLarge - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### ServerFarmWithRichSku -Parameter 'AppServicePlan' accepts value of type 'ServerFarmWithRichSku' from the pipeline - -## OUTPUTS - -### Microsoft.Azure.Management.WebSites.Models.ServerFarmWithRichSku - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebApp.md deleted file mode 100644 index e22c93b2ba..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebApp.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.Websites -ms.assetid: 4166119F-D26A-45A1-B040-D7B2459833D6 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebapp -schema: 2.0.0 ---- - -# Set-AzureRmWebApp - -## SYNOPSIS -Modifies an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebApp [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [[-AutoSwapSlotName] <String>] [-HostNames <String[]>] [-NumberOfWorkers <Int32>] [-AsJob] [[-AssignIdentity] <Boolean>] - [[-HttpsOnly] <Boolean>] [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebApp [[-Use32BitWorkerProcess] <Boolean>] [[-AutoSwapSlotName] <String>] - [-NumberOfWorkers <Int32>] [-AsJob] [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebApp** cmdlet sets an Azure Web App. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -HttpLoggingEnabled $true -``` - -This command sets HttpLoggingEnabled to true for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettings -App Settings HashTable - -```yaml -Type: Hashtable -Parameter Sets: S1 -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignIdentity -Enable/disable MSI on an existing azure webapp or functionapp [PREVIEW] - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSwapSlotName -Destination slot name for auto swap - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionStrings -Connection Strings HashTable - -```yaml -Type: Hashtable -Parameter Sets: S1 -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDocuments -Default Documents String Array - -```yaml -Type: String[] -Parameter Sets: S1 -Aliases: - -Required: False -Position: 3 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedErrorLoggingEnabled -Detailed Error Logging Enabled Boolean - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HandlerMappings -Handler Mappings IList - -```yaml -Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] -Parameter Sets: S1 -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostNames -WebApp HostNames String Array - -```yaml -Type: String[] -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpLoggingEnabled -HttpLoggingEnabled Boolean - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsOnly -Enable/disable redirecting all traffic to HTTPS on an existing azure webapp or functionapp - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPipelineMode -Managed Pipeline Mode Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: -Accepted values: Classic, Integrated - -Required: False -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetFrameworkVersion -Net Framework Version - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfWorkers -The number of workers to be allocated - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PhpVersion -Php Version - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTracingEnabled -Request Tracing Enabled - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Use32BitWorkerProcess -Use 32-bit Worker Process Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebSocketsEnabled -WebSocketsEnabled Boolean - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: 13 -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Int32 -Parameter 'NumberOfWorkers' accepts value of type 'Int32' from the pipeline - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlot.md deleted file mode 100644 index 6144b79dcd..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlot.md +++ /dev/null @@ -1,430 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: FA868206-D8B0-4868-A1D1-D3F96BF3ADCC -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebappslot -schema: 2.0.0 ---- - -# Set-AzureRmWebAppSlot - -## SYNOPSIS -Modifies an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-ResourceGroupName] <String> [-Name] <String> - [[-AssignIdentity] <Boolean>] [[HttpsOnly] <Boolean>] [-Slot] <String> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebAppSlot [[-AppServicePlan] <String>] [[-DefaultDocuments] <String[]>] - [[-NetFrameworkVersion] <String>] [[-PhpVersion] <String>] [[-RequestTracingEnabled] <Boolean>] - [[-HttpLoggingEnabled] <Boolean>] [[-DetailedErrorLoggingEnabled] <Boolean>] [[-AppSettings] <Hashtable>] - [[-ConnectionStrings] <Hashtable>] - [[-HandlerMappings] <System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping]>] - [[-ManagedPipelineMode] <String>] [[-WebSocketsEnabled] <Boolean>] [[-Use32BitWorkerProcess] <Boolean>] - [-AutoSwapSlotName <String>] [-NumberOfWorkers <Int32>] [-WebApp] <Site> [-AsJob] - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebApp** cmdlet sets an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -HttpLoggingEnabled $true -``` - -This command sets HttpLoggingEnabled to true for Slot Slot001 pertaining to Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppServicePlan -App Service Plan Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSettings -App Settings HashTable - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoSwapSlotName -Destination slot name for auto swap - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionStrings -Connection Strings HashTable - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultDocuments -Default Documents String Array - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -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 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DetailedErrorLoggingEnabled -Detailed Error Logging Enabled Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HandlerMappings -Handler Mappings IList - -```yaml -Type: System.Collections.Generic.IList`1[Microsoft.Azure.Management.WebSites.Models.HandlerMapping] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 12 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpLoggingEnabled -HttpLoggingEnabled Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPipelineMode -Managed Pipeline Mode Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Classic, Integrated - -Required: False -Position: 13 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetFrameworkVersion -Net Framework Version - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfWorkers -The number of workers to be allocated - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PhpVersion -Php Version - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestTracingEnabled -Request Tracing Enabled Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Use32BitWorkerProcess -Use 32-bit Worker Process Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 15 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebSocketsEnabled -Web Sockets Enabled Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 14 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -HttpsOnly -Enable/disable redirecting all traffic to HTTPS on an existing slot - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AssignIdentity -Enable/disable MSI on an existing slot [PREVIEW] - -```yaml -Type: Boolean -Parameter Sets: S1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run cmdlet in the background - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Int32 -Parameter 'NumberOfWorkers' accepts value of type 'Int32' from the pipeline - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Start-AzureRMWebAppSlot](./Start-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmAppServicePlan](./Get-AzureRmAppServicePlan.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlotConfigName.md b/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlotConfigName.md deleted file mode 100644 index 7928e94fe0..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Set-AzureRmWebAppSlotConfigName.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 7DBF937E-2D01-4356-9A5F-C5A4CB6D1A10 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/set-azurermwebappslotconfigname -schema: 2.0.0 ---- - -# Set-AzureRmWebAppSlotConfigName - -## SYNOPSIS -Set Web App Slot Config names - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Set-AzureRmWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] - [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-ResourceGroupName] <String> [-Name] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Set-AzureRmWebAppSlotConfigName [[-AppSettingNames] <String[]>] [[-ConnectionStringNames] <String[]>] - [-RemoveAllAppSettingNames] [-RemoveAllConnectionStringNames] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Set-AzureRmWebAppSlotConfigName** cmdlet marks App Settings and Connection Strings as slot settings - -## EXAMPLES - -### 1: -``` -PS C:\> Set-AzureRmWebAppSlotConfigName -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -RemoveAllAppSettingNames -RemoveAllConnectionStringNames -``` - -This command removes all app settings and connection strings for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## PARAMETERS - -### -AppSettingNames -App Settings Names String Array - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ConnectionStringNames -Connection String Names String Array - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemoveAllAppSettingNames -Remove All App Setting Names Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveAllConnectionStringNames -Remove All Connection String Names Option - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebApp.md deleted file mode 100644 index 38e8db044c..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebApp.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: D70A61D8-0C9A-4BDB-A546-37C32D25797C -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/start-azurermwebapp -schema: 2.0.0 ---- - -# Start-AzureRmWebApp - -## SYNOPSIS -Starts an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Start-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Start-AzureRmWebApp [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmWebApp** cmdlet starts an Azure Web App. - -## EXAMPLES - -### Example 1: Start a Web App -``` -PS C:\>Start-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command starts the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Stop-AzureRmWebApp](./Stop-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebAppSlot.md deleted file mode 100644 index 3b69c5cd7c..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Start-AzureRmWebAppSlot.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 0FDDDEE1-CEAD-46DA-A7EB-EE477ED59749 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/start-azurermwebappslot -schema: 2.0.0 ---- - -# Start-AzureRmWebAppSlot - -## SYNOPSIS -Starts an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Start-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Start-AzureRmWebAppSlot [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Start-AzureRmWebAppSlot** cmdlet starts an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Start-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command starts the Slot named Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRMWebAppSlot](./Get-AzureRMWebAppSlot.md) - -[New-AzureRMWebAppSlot](./New-AzureRMWebAppSlot.md) - -[Remove-AzureRMWebAppSlot](./Remove-AzureRMWebAppSlot.md) - -[Restart-AzureRMWebAppSlot](./Restart-AzureRMWebAppSlot.md) - -[Set-AzureRMWebAppSlot](./Set-AzureRMWebAppSlot.md) - -[Stop-AzureRMWebAppSlot](./Stop-AzureRMWebAppSlot.md) - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) diff --git a/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebApp.md b/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebApp.md deleted file mode 100644 index 632364bd1f..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebApp.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: A12FFDB1-9849-4150-9716-068BE6EFC681 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/stop-azurermwebapp -schema: 2.0.0 ---- - -# Stop-AzureRmWebApp - -## SYNOPSIS -Stops an Azure Web App. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Stop-AzureRmWebApp [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] - [<CommonParameters>] -``` - -### S2 -``` -Stop-AzureRmWebApp [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmWebApp** cmdlet stops an Azure Web App. - -## EXAMPLES - -### Example 1: Stop a Web App -``` -PS C:\>Stop-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command stops the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AzureRmWebApp](./Get-AzureRmWebApp.md) - -[New-AzureRmWebApp](./New-AzureRmWebApp.md) - -[Remove-AzureRmWebApp](./Remove-AzureRmWebApp.md) - -[Restart-AzureRmWebApp](./Restart-AzureRmWebApp.md) - -[Start-AzureRmWebApp](./Start-AzureRmWebApp.md) - - diff --git a/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebAppSlot.md deleted file mode 100644 index 20d9ae72c8..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Stop-AzureRmWebAppSlot.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 86E0D477-DD32-49BD-82E7-1CF191E4F612 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/stop-azurermwebappslot -schema: 2.0.0 ---- - -# Stop-AzureRmWebAppSlot - -## SYNOPSIS -Stops an Azure Web App slot. - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Stop-AzureRmWebAppSlot [-ResourceGroupName] <String> [-Name] <String> [-Slot] <String> - [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -### S2 -``` -Stop-AzureRmWebAppSlot [-WebApp] <Site> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] -``` - -## DESCRIPTION -The **Stop-AzureRmWebAppSlot** cmdlet stops an Azure Web App Slot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-AzureRmWebAppSlot -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -Slot "Slot001" -``` - -This command stops the slot Slot001 pertaining to the Web App named ContosoWebApp that belongs to the resource group named Default-Web-WestUS. - -## 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 -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Slot -WebApp Slot Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/azurermps-2.5.0/AzureRm.Websites/Switch-AzureRmWebAppSlot.md b/azurermps-2.5.0/AzureRm.Websites/Switch-AzureRmWebAppSlot.md deleted file mode 100644 index 9b65ed3f40..0000000000 --- a/azurermps-2.5.0/AzureRm.Websites/Switch-AzureRmWebAppSlot.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: Microsoft.Azure.Commands.Websites.dll-Help.xml -Module Name: AzureRM.WebSites -ms.assetid: 258A4EA9-B82C-4664-8DCE-30D47A623868 -online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.websites/switch-azurermwebappslot -schema: 2.0.0 ---- - -# Switch-AzureRmWebAppSlot - -## SYNOPSIS -Swap two slots with a Web App - -[!INCLUDE [migrate-to-az-banner](../../includes/migrate-to-az-banner.md)] - -## SYNTAX - -### S1 -``` -Switch-AzureRmWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] - [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-ResourceGroupName] <String> - [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -### S2 -``` -Switch-AzureRmWebAppSlot [-SourceSlotName] <String> [[-DestinationSlotName] <String>] - [[-SwapWithPreviewAction] <SwapWithPreviewAction>] [[-PreserveVnet] <Boolean>] [-WebApp] <Site> - [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] -``` - -## DESCRIPTION -The **Switch-AzureRmWebAppSlot** switches two slots associated with an Azure Web App. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Switch-AzureRmWebAppSlot -SourceSlotName "sourceslot" -DestinationSlotName "destinationslot" -ResourceGroupName "Default-Web-WestUS" -Name "ContosoWebApp" -``` - -This command will switch slot "sourceslot" slot with "destinationslot" for Web App ContosoWebApp associated with the resource group Default-Web-WestUS - -## 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 -``` - -### -DestinationSlotName -Destination Slot Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -WebApp Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreserveVnet -Preserve Vnet Boolean - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Resource Group Name - -```yaml -Type: String -Parameter Sets: S1 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSlotName -Source Slot Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwapWithPreviewAction -Swap With Preview Action - -```yaml -Type: SwapWithPreviewAction -Parameter Sets: (All) -Aliases: -Accepted values: ApplySlotConfig, CompleteSlotSwap, ResetSlotSwap - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebApp -WebApp Object - -```yaml -Type: Site -Parameter Sets: S2 -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Site -Parameter 'WebApp' accepts value of type 'Site' from the pipeline - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docfx.json b/docfx.json index 2ba14d39a0..1f682b4a72 100644 --- a/docfx.json +++ b/docfx.json @@ -18,10 +18,6 @@ { "files": ["**/*.yml"], "src": "azurermps-6.13.0", "version": "azurermps-6.13.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azurermps-6.13.0", "version": "azurermps-6.13.0", "dest": "azure/azurerm" }, - { "files": ["toc.yml"], "src": "azurermps-2.5.0", "version": "azurermps-2.5.0", "dest": "module/azure-rm" }, - { "files": ["**/*.yml"], "src": "azurermps-2.5.0", "version": "azurermps-2.5.0", "exclude": ["docs-conceptual/**"], "dest": "module" }, - { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azurermps-2.5.0", "version": "azurermps-2.5.0", "dest": "azure/azurerm" }, - { "files": ["toc.yml"], "src": "azuresmps-4.0.0", "version": "azuresmps-4.0.0", "dest": "module/servicemanagement" }, { "files": ["**/*.yml"], "src": "azuresmps-4.0.0", "version": "azuresmps-4.0.0", "exclude": ["docs-conceptual/**"], "dest": "module/servicemanagement" }, { "files": ["**/*.yml", "**/*.md"], "src": "docs-conceptual/azuresmps-4.0.0", "version": "azuresmps-4.0.0", "dest": "azure/servicemanagement" }, @@ -91,15 +87,13 @@ { "files": ["media/**"], "version": "azps-10.0.0" }, { "files": ["media/**"], "version": "azps-9.7.1" }, { "files": ["media/**"], "version": "azps-0.10.0" }, - { "files": ["media/**"], "version": "azurermps-6.13.0" }, - { "files": ["media/**"], "version": "azurermps-2.5.0" } + { "files": ["media/**"], "version": "azurermps-6.13.0" } ], "versions": { "azps-10.0.0": { "dest": "azps-10.0.0" }, "azps-9.7.1": { "dest": "azps-9.7.1" }, "azps-0.10.0": { "dest": "azps-0.10.0" }, "azurermps-6.13.0": { "dest": "azurermps-6.13.0" }, - "azurermps-2.5.0": { "dest": "azurermps-2.5.0" }, "azuresmps-4.0.0": { "dest": "azuresmps-4.0.0" }, "azuredmps-0.9.0-preview": { "dest": "azuredmps-0.9.0-preview" }, "azurestackps-2.2.0": { "dest": "azurestackps-2.2.0" }, @@ -537,7 +531,6 @@ "azps-9.7.1/**/*.yml": "04/28/2023", "azps-0.10.0/**/*.yml": "4/14/2020", "azurermps-6.13.0/**/*.yml": "03/23/2021", - "azurermps-2.5.0/**/*.yml": "05/09/2019", "azuresmps-4.0.0/**/*.yml": "11/28/2020", "azuredmps-*/**/*.yml": "09/28/2018", "azurestackps-2.2.0/**/*.yml": "09/23/2021", @@ -574,7 +567,6 @@ "azps-9.7.1/**/*": "None", "azps-0.10.0/**/*": "None", "azurermps-6.13.0/**/*": "None", - "azurermps-2.5.0/**/*": "None", "azuresmps-4.0.0/**/*": "None", "azuredmps-0.9.0/**/*": "None", "azurestackps-2.2.0/**/*": "None", diff --git a/docs-conceptual/azurermps-2.5.0/TOC.yml b/docs-conceptual/azurermps-2.5.0/TOC.yml deleted file mode 100644 index ea463e30f9..0000000000 --- a/docs-conceptual/azurermps-2.5.0/TOC.yml +++ /dev/null @@ -1,7 +0,0 @@ -- name: Azure PowerShell for Azure Stack - href: overview.md - items: - - name: Install - href: /azure/azure-stack/azure-stack-powershell-install?toc=%2fpowershell%2fazure%2fazure-stack%2ftoc.json - - name: Configure - href: /azure/azure-stack/azure-stack-powershell-configure-admin \ No newline at end of file diff --git a/docs-conceptual/azurermps-2.5.0/overview.md b/docs-conceptual/azurermps-2.5.0/overview.md deleted file mode 100644 index 0dd755e986..0000000000 --- a/docs-conceptual/azurermps-2.5.0/overview.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Overview of Azure Stack PowerShell | Microsoft Docs -description: An overview of Azure Stack PowerShell with instructions for installation and configuration. -author: bganapa -ms.author: bganapa -manager: knithinc -ms.devlang: powershell -ms.topic: conceptual -ms.manager: knithinc -ms.date: 09/21/2018 -ms.custom: devx-track-azurepowershell ---- -# AzureRM Module 2.5.0 - -## Requirements: -Minimum supported Azure Stack version is 1904. - -Note: If you are using an earlier version install version 1.2.11 - - -## Install -```powershell-interactive -# Remove previous versions of AzureStack modules -Uninstall-Module -Name AzureStack -Force -Uninstall-Module -Name AzureRM -Force -Uninstall-Module AzureRM.AzureStackAdmin -Force -ErrorAction Continue -Uninstall-Module AzureRM.AzureStackStorage -Force -ErrorAction Continue -Get-Module Azs.* -ListAvailable | Uninstall-Module -Force -Get-Module Azure.* -ListAvailable | Uninstall-Module -Force - - -# Install the AzureRM.Bootstrapper module. Select Yes when prompted to install NuGet -Install-Module -Name AzureRm.BootStrapper - -# Install and import the API Version Profile required by Azure Stack into the current PowerShell session. -Use-AzureRmProfile -Profile 2018-03-01-hybrid -Force - -``` - -## Release Notes -* AzureRm.Resources - * New Resources module supporting 2018-05-01 api version with 2019-03-01-hybrid profile - * PolicyDefinition(2016-12-01) and PolicyAssisgment(2017-06-01-preview) operations are still with old api versions -* AzureRm.Compute - * New compute module supporting 2017-12-01 api version.' - - -* This release corresponds to the azurestack specific api profile 2019-03-01-hybrid -* All the modules are taking greater than or equal to dependency on the AzureRm.Profile module. -* Api version suppoerted by each of the modules are updated. - * Compute - 2017-12-30 - * Network - 2017-10-01 - * Storage - 2016-01-01 - * Resources - 2018-02-01 - * Keyvault - 2016-10-01 - * Dns - 2016-04-01 -* The complete api version map for each of the resource types can be found at https://github.com/Azure/azure-rest-api-specs/blob/master/profile/2018-03-01-hybrid.json - -## Content: -### Azure Bridge -Preview release of the Azure Stack AzureBridge administrator module which allows you to syndicate images from Azure. - -### Backup -Preview release of the Backup administrator module that allows administrators to: -- Configure where backups are stored -- Perform backups -- List and restore completed backup - -### Commerce -Preview release of the Azure Stack Commerce administrator module which provides a way to view aggregate data usage across your Azure Stack system. - -### Compute -Preview release of the Azure Stack Compute administrator module which provides functionality to manage compute quotas, platform images, managed disks and virtual machine extensions. - -### Fabric -Preview release of the Azure Stack Fabric administrator module which allows administrators to view and manage infrastructure components: -- Stop, Start and Shutdown of scale unit nodes -- Drain and Resume of scale unit nodes for FRU related activities -- Repair of scale unit nodes -- Restart of Infrastructure role -- Stop, Start and Shutdown of Infrastructure role instances -- Create new IP Pools - - -### Gallery -Preview release of the Azure Stack Gallery administrator module which provides functionality to manage gallery items in the Azure Stack marketplace. - -### Infrastructure Insights -Preview release of the Infrastructure Insights administrator module which allows administrators: -- View the health of their Azure Stack stamp resources -- View and manage alerts - -### KeyVault -Preview release of the Azure Stack KeyVault administrator module which allows administrator to view KeyVault quotas. - -### Network -Preview release of the Network administrator module which allows: -- Management of network quotas -- View allocated network resources such as public IP addresses, virtual networks, load balancers -- Provides a cmdlet which displays an administrator overview - -### Storage -Preview release of the Azure Stack Storage administrator module. In this release we provide the functionality to: -- Manage storage quotas -- Garbage collect deleted storage resources -- Restore deleted storage accounts -- Migrate containers from one share to another -- View information about the individual storage components -- View usage and performance information - -### Subscription Admin -Preview release of the Azure Stack Subscription administrator module. This module provides functionality for administrators to: -- Manage plans and offers -- View usage and performance information -- Manage RBAC - -### Subscription -Preview release of the Azure Stack Subscription module. This module provides functionality for Users to: -- Create, Delete and Update Subscriptions - -### Update -Preview release of the Azure Stack Update administrator module. In this module administrators can: -- List and install available updates -- Resume interrupted updates -- View installed updates diff --git a/mapping/monikerMapping.json b/mapping/monikerMapping.json index c8bbd203a5..d8954ac697 100644 --- a/mapping/monikerMapping.json +++ b/mapping/monikerMapping.json @@ -27,13 +27,6 @@ "referenceTocUrl": "/powershell/module/deploymentmanager/toc.json", "serviceMap": "mapping/dm-groupMapping-0.9.0.json" }, - "azurermps-2.5.0": { - "conceptualToc": "docs-conceptual/azurermps-2.5.0/toc.yml", - "conceptualTocUrl": "/powershell/azure/azurerm/toc.json", - "packageRoot": "azurermps-2.5.0", - "referenceTocUrl": "/powershell/module/azure-powershell/toc.json", - "serviceMap": "mapping/rm-groupMapping-2.5.0.json" - }, "azurermps-6.13.0": { "conceptualToc": "docs-conceptual/azurermps-6.13.0/toc.yml", "conceptualTocUrl": "/powershell/azure/azurerm/toc.json", diff --git a/mapping/rm-groupMapping-2.5.0.json b/mapping/rm-groupMapping-2.5.0.json deleted file mode 100644 index 58064f4698..0000000000 --- a/mapping/rm-groupMapping-2.5.0.json +++ /dev/null @@ -1,816 +0,0 @@ -{ - "Undo-AzureKeyVaultManagedStorageSasDefinitionRemoval": "Key Vault", - "Add-AzureRmKeyVaultNetworkRule": "Key Vault", - "Set-AzureKeyVaultCertificateIssuer": "Key Vault", - "Backup-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Set-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Add-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Remove-AzureRmKeyVault": "Key Vault", - "Undo-AzureRmKeyVaultRemoval": "Key Vault", - "Add-AzureKeyVaultCertificate": "Key Vault", - "Get-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Update-AzureRmKeyVaultNetworkRuleSet": "Key Vault", - "Import-AzureKeyVaultCertificate": "Key Vault", - "Remove-AzureRmKeyVaultNetworkRule": "Key Vault", - "Undo-AzureKeyVaultSecretRemoval": "Key Vault", - "Remove-AzureRmKeyVaultAccessPolicy": "Key Vault", - "Add-AzureKeyVaultCertificateContact": "Key Vault", - "Update-AzureKeyVaultManagedStorageAccount": "Key Vault", - "New-AzureKeyVaultCertificatePolicy": "Key Vault", - "Set-AzureRmKeyVaultAccessPolicy": "Key Vault", - "Remove-AzureKeyVaultCertificateIssuer": "Key Vault", - "Undo-AzureKeyVaultCertificateRemoval": "Key Vault", - "New-AzureKeyVaultCertificateOrganizationDetails": "Key Vault", - "Get-AzureKeyVaultCertificatePolicy": "Key Vault", - "Get-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultSecret": "Key Vault", - "Undo-AzureKeyVaultManagedStorageAccountRemoval": "Key Vault", - "Backup-AzureKeyVaultCertificate": "Key Vault", - "Get-AzureKeyVaultCertificate": "Key Vault", - "Update-AzureKeyVaultCertificate": "Key Vault", - "Set-AzureKeyVaultSecret": "Key Vault", - "Get-AzureKeyVaultKey": "Key Vault", - "Add-AzureKeyVaultKey": "Key Vault", - "Get-AzureKeyVaultCertificateIssuer": "Key Vault", - "Backup-AzureKeyVaultKey": "Key Vault", - "Undo-AzureKeyVaultKeyRemoval": "Key Vault", - "Update-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultCertificateOperation": "Key Vault", - "Remove-AzureKeyVaultCertificateContact": "Key Vault", - "New-AzureKeyVaultCertificateAdministratorDetails": "Key Vault", - "Update-AzureKeyVaultKey": "Key Vault", - "Restore-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Set-AzureKeyVaultCertificatePolicy": "Key Vault", - "Remove-AzureKeyVaultManagedStorageAccount": "Key Vault", - "Remove-AzureKeyVaultCertificate": "Key Vault", - "Update-AzureKeyVaultManagedStorageAccountKey": "Key Vault", - "Get-AzureKeyVaultCertificateContact": "Key Vault", - "Backup-AzureKeyVaultSecret": "Key Vault", - "Get-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Restore-AzureKeyVaultCertificate": "Key Vault", - "Stop-AzureKeyVaultCertificateOperation": "Key Vault", - "Remove-AzureKeyVaultManagedStorageSasDefinition": "Key Vault", - "Restore-AzureKeyVaultSecret": "Key Vault", - "Remove-AzureKeyVaultKey": "Key Vault", - "Get-AzureRmKeyVault": "Key Vault", - "Get-AzureKeyVaultCertificateOperation": "Key Vault", - "Restore-AzureKeyVaultKey": "Key Vault", - "New-AzureRmKeyVault": "Key Vault", - "Set-AzureKeyVaultCertificateAttribute": "Key Vault", - "Set-AzureKeyVaultKeyAttribute": "Key Vault", - "Set-AzureKeyVaultSecretAttribute": "Key Vault", - "New-AzureRmDnsZone": "DNS", - "New-AzureRmDnsRecordConfig": "DNS", - "Set-AzureRmDnsZone": "DNS", - "Get-AzureRmDnsZone": "DNS", - "New-AzureRmDnsRecordSet": "DNS", - "Remove-AzureRmDnsRecordSet": "DNS", - "Get-AzureRmDnsRecordSet": "DNS", - "Add-AzureRmDnsRecordConfig": "DNS", - "Set-AzureRmDnsRecordSet": "DNS", - "Remove-AzureRmDnsZone": "DNS", - "Remove-AzureRmDnsRecordConfig": "DNS", - "Get-UsageAggregates": "Usage Aggregates", - "Remove-AzureRmAppServicePlan": "App Service", - "Get-AzureRmWebAppSlotPublishingProfile": "App Service", - "Get-AzureRmWebAppPublishingProfile": "App Service", - "Set-AzureRmWebApp": "App Service", - "Restore-AzureRmWebAppSnapshot": "App Service", - "Set-AzureRmWebAppSlot": "App Service", - "New-AzureRmWebAppDatabaseBackupSetting": "App Service", - "Restart-AzureRmWebAppSlot": "App Service", - "Start-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackupConfiguration": "App Service", - "Reset-AzureRmWebAppPublishingProfile": "App Service", - "Get-AzureRmWebAppSSLBinding": "App Service", - "Remove-AzureRmWebAppBackup": "App Service", - "Get-AzureRmWebAppCertificate": "App Service", - "Get-AzureRmWebAppSnapshot": "App Service", - "Restore-AzureRmWebAppBackup": "App Service", - "Get-AzureRmAppServicePlanMetrics": "App Service", - "Get-AzureRmWebAppSlotConfigName": "App Service", - "Get-AzureRmAppServicePlan": "App Service", - "Edit-AzureRmWebAppBackupConfiguration": "App Service", - "Get-AzureRmWebAppMetrics": "App Service", - "Switch-AzureRmWebAppSlot": "App Service", - "Remove-AzureRmWebApp": "App Service", - "Stop-AzureRmWebAppSlot": "App Service", - "Remove-AzureRmWebAppSlot": "App Service", - "New-AzureRmWebAppSSLBinding": "App Service", - "New-AzureRmWebApp": "App Service", - "Start-AzureRmWebAppSlot": "App Service", - "Set-AzureRmAppServicePlan": "App Service", - "Restart-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackupList": "App Service", - "Set-AzureRmWebAppSlotConfigName": "App Service", - "New-AzureRmAppServicePlan": "App Service", - "Get-AzureRmWebApp": "App Service", - "Get-AzureRmWebAppBackup": "App Service", - "New-AzureRmWebAppBackup": "App Service", - "Get-AzureRmWebAppSlotMetrics": "App Service", - "Get-AzureRmWebAppSlot": "App Service", - "Stop-AzureRmWebApp": "App Service", - "Remove-AzureRmWebAppSSLBinding": "App Service", - "Reset-AzureRmWebAppSlotPublishingProfile": "App Service", - "New-AzureRmWebAppSlot": "App Service", - "Remove-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Set-AzureRmApplicationInsightsDailyCap": "Monitor", - "New-AzureRmApplicationInsights": "Monitor", - "Set-AzureRmApplicationInsightsPricingPlan": "Monitor", - "Get-AzureRmApplicationInsights": "Monitor", - "New-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Remove-AzureRmApplicationInsights": "Monitor", - "New-AzureRmApplicationInsightsApiKey": "Monitor", - "Remove-AzureRmApplicationInsightsApiKey": "Monitor", - "Set-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Get-AzureRmApplicationInsightsContinuousExport": "Monitor", - "Get-AzureRmApplicationInsightsApiKey": "Monitor", - "Set-AzureRmPolicySetDefinition": "Policies", - "Remove-AzureRmDeployment": "Resources", - "Get-AzureRmADGroupMember": "Active Directory", - "Remove-AzureRmPolicyDefinition": "Policies", - "Move-AzureRmResource": "Resources", - "New-AzureRmADAppCredential": "Active Directory", - "Test-AzureRmResourceGroupDeployment": "Resources", - "Get-AzureRmManagedApplicationDefinition": "Resources", - "Register-AzureRmProviderFeature": "Resources", - "Get-AzureRmResourceGroupDeployment": "Resources", - "Get-AzureRmResource": "Resources", - "Remove-AzureRmADUser": "Active Directory", - "Remove-AzureRmADApplication": "Active Directory", - "Get-AzureRmPolicySetDefinition": "Policies", - "New-AzureRmPolicySetDefinition": "Policies", - "Add-AzureRmADGroupMember": "Active Directory", - "Unregister-AzureRmResourceProvider": "Resources", - "Remove-AzureRmManagedApplicationDefinition": "Resources", - "Remove-AzureRmResourceLock": "Resources", - "Get-AzureRmManagementGroup": "Resources", - "New-AzureRmADUser": "Active Directory", - "New-AzureRmResourceLock": "Resources", - "Get-AzureRmADUser": "Active Directory", - "Get-AzureRmResourceGroupDeploymentOperation": "Resources", - "Get-AzureRmPolicyAssignment": "Policies", - "Remove-AzureRmManagedApplication": "Resources", - "New-AzureRmADSpCredential": "Active Directory", - "Set-AzureRmResourceGroup": "Resources", - "Get-AzureRmProviderFeature": "Resources", - "Get-AzureRmADServicePrincipal": "Active Directory", - "Test-AzureRmDeployment": "Resources", - "Stop-AzureRmDeployment": "Resources", - "Get-AzureRmResourceGroup": "Resources", - "Get-AzureRmPolicyDefinition": "Policies", - "Get-AzureRmPolicyAlias": "Policies", - "New-AzureRmADServicePrincipal": "Active Directory", - "Invoke-AzureRmResourceAction": "Resources", - "Update-AzureRmADServicePrincipal": "Active Directory", - "Get-AzureRmLocation": "Resources", - "Get-AzureRmDeployment": "Resources", - "Get-AzureRmProviderOperation": "Resources", - "Remove-AzureRmRoleAssignment": "Resources", - "New-AzureRmADGroup": "Active Directory", - "Update-AzureRmADUser": "Active Directory", - "Update-AzureRmManagementGroup": "Resources", - "Register-AzureRmResourceProvider": "Resources", - "Remove-AzureRmADAppCredential": "Active Directory", - "Get-AzureRmRoleAssignment": "Resources", - "Get-AzureRmADApplication": "Active Directory", - "Get-AzureRmADGroup": "Active Directory", - "Get-AzureRmManagedApplication": "Resources", - "Get-AzureRmResourceProvider": "Resources", - "Set-AzureRmPolicyDefinition": "Policies", - "Remove-AzureRmPolicyAssignment": "Policies", - "New-AzureRmManagedApplication": "Resources", - "Remove-AzureRmADServicePrincipal": "Active Directory", - "Set-AzureRmManagedApplication": "Resources", - "Set-AzureRmResource": "Resources", - "Remove-AzureRmADSpCredential": "Active Directory", - "Remove-AzureRmResource": "Resources", - "New-AzureRmADApplication": "Active Directory", - "Remove-AzureRmResourceGroup": "Resources", - "Set-AzureRmPolicyAssignment": "Policies", - "Get-AzureRmADAppCredential": "Active Directory", - "New-AzureRmManagementGroup": "Resources", - "New-AzureRmManagedApplicationDefinition": "Resources", - "Set-AzureRmRoleDefinition": "Resources", - "New-AzureRmResourceGroup": "Resources", - "Get-AzureRmResourceLock": "Resources", - "Remove-AzureRmADGroup": "Active Directory", - "Remove-AzureRmRoleDefinition": "Resources", - "New-AzureRmPolicyAssignment": "Policies", - "New-AzureRmPolicyDefinition": "Policies", - "Get-AzureRmADSpCredential": "Active Directory", - "Export-AzureRmResourceGroup": "Resources", - "New-AzureRmResource": "Resources", - "Get-AzureRmDeploymentOperation": "Resources", - "Remove-AzureRmADGroupMember": "Active Directory", - "New-AzureRmManagementGroupSubscription": "Resources", - "Remove-AzureRmPolicySetDefinition": "Policies", - "New-AzureRmRoleDefinition": "Resources", - "Remove-AzureRmManagementGroup": "Resources", - "New-AzureRmResourceGroupDeployment": "Resources", - "New-AzureRmRoleAssignment": "Resources", - "Get-AzureRmRoleDefinition": "Resources", - "Save-AzureRmResourceGroupDeploymentTemplate": "Resources", - "Remove-AzureRmResourceGroupDeployment": "Resources", - "Set-AzureRmManagedApplicationDefinition": "Resources", - "Set-AzureRmResourceLock": "Resources", - "Remove-AzureRmManagementGroupSubscription": "Resources", - "Update-AzureRmADApplication": "Active Directory", - "Save-AzureRmDeploymentTemplate": "Resources", - "New-AzureRmDeployment": "Resources", - "Stop-AzureRmResourceGroupDeployment": "Resources", - "Set-AzureRmVMPlan": "Virtual Machines", - "New-AzureRmImage": "VM Images", - "Remove-AzureRmVMCustomScriptExtension": "VM Extensions", - "Remove-AzureRmVmss": "VM Scale Sets", - "Get-AzureRmVMDscExtensionStatus": "VM Extensions", - "Set-AzureRmVMExtension": "VM Extensions", - "New-AzureRmDiskUpdateConfig": "VM Disks", - "Get-AzureRmVmssVMDiskEncryption": "VM Scale Sets", - "Set-AzureRMVMDiagnosticsExtension": "VM Extensions", - "Grant-AzureRmSnapshotAccess": "VM Snapshots", - "Disable-AzureRmVmssDiskEncryption": "VM Scale Sets", - "Get-AzureRmVMDscExtension": "VM Extensions", - "Save-AzureRmVhd": "VM VHDs", - "Get-AzureRmVMAccessExtension": "VM Extensions", - "Set-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmVMOperatingSystem": "Virtual Machines", - "Add-AzureRmVmssSshPublicKey": "VM Scale Sets", - "Get-AzureRmVmssVM": "VM Scale Sets", - "Get-AzureRMVMDiagnosticsExtension": "VM Extensions", - "Get-AzureRmVMDiskEncryptionStatus": "VM Disks", - "Remove-AzureRmVMNetworkInterface": "Virtual Machines", - "Remove-AzureRmVmssDataDisk": "VM Scale Sets", - "New-AzureRmVMSqlServerAutoBackupConfig": "Virtual Machines", - "Add-AzureRmVmssDiagnosticsExtension": "VM Scale Sets", - "Start-AzureRmVM": "Virtual Machines", - "Get-AzureRmVMChefExtension": "VM Extensions", - "Get-AzureRmVM": "Virtual Machines", - "ConvertTo-AzureRmVMManagedDisk": "VM Disks", - "Get-AzureRmVmssRollingUpgrade": "VM Scale Sets", - "Disable-AzureRmVMDiskEncryption": "VM Disks", - "Add-AzureRMVhd": "VM VHDs", - "Set-AzureRmVMADDomainExtension": "VM Extensions", - "Set-AzureRmVMBackupExtension": "VM Extensions", - "Get-AzureRmAvailabilitySet": "Virtual Machines", - "Set-AzureRmDiskImageReference": "VM Images", - "Get-AzureRmVMBootDiagnosticsData": "Virtual Machines", - "Stop-AzureRmVmssRollingUpgrade": "VM Scale Sets", - "Set-AzureRmSnapshotKeyEncryptionKey": "VM Snapshots", - "New-AzureRmVmssIpTagConfig": "VM Scale Sets", - "Set-AzureRmVMAEMExtension": "VM Extensions", - "Remove-AzureRmSnapshot": "VM Snapshots", - "Remove-AzureRmVMDataDisk": "VM Disks", - "New-AzureRmVmss": "VM Scale Sets", - "Remove-AzureRmVM": "Virtual Machines", - "Add-AzureRmImageDataDisk": "VM Images", - "Remove-AzureRmContainerServiceAgentPoolProfile": "Container Service", - "Get-AzureRmVMAEMExtension": "VM Extensions", - "Set-AzureRmDiskDiskEncryptionKey": "VM Disks", - "Stop-AzureRmVmss": "VM Scale Sets", - "New-AzureRmSnapshotUpdateConfig": "VM Snapshots", - "Export-AzureRmLogAnalyticThrottledRequests": "Virtual Machines", - "Update-AzureRmVM": "Virtual Machines", - "Revoke-AzureRmSnapshotAccess": "VM Snapshots", - "Get-AzureRmVmssSku": "VM Scale Sets", - "Get-AzureRmVMImage": "VM Images", - "Set-AzureRmVM": "Virtual Machines", - "Add-AzureRmVmssAdditionalUnattendContent": "VM Scale Sets", - "Set-AzureRmVMCustomScriptExtension": "VM Extensions", - "Remove-AzureRmContainerService": "Container Service", - "Add-AzureRmVmssSecret": "VM Scale Sets", - "Update-AzureRmSnapshot": "VM Snapshots", - "New-AzureRmVmssConfig": "VM Scale Sets", - "Get-AzureRMVMSqlServerExtension": "VM Extensions", - "Set-AzureRmVMBootDiagnostics": "Virtual Machines", - "New-AzureRmVmssVaultCertificateConfig": "VM Scale Sets", - "Publish-AzureRmVMDscConfiguration": "Virtual Machines", - "Set-AzureRmVMOSDisk": "VM Disks", - "Get-AzureRmVMImagePublisher": "VM Images", - "Set-AzureRmVMDiskEncryptionExtension": "VM Disks", - "Remove-AzureRmDisk": "VM Disks", - "New-AzureRmVMConfig": "Virtual Machines", - "Save-AzureRmVMImage": "VM Images", - "Remove-AzureRmVMDscExtension": "VM Extensions", - "Get-AzureRmVMImageSku": "VM Images", - "Get-AzureRmVMADDomainExtension": "VM Extensions", - "Add-AzureRmContainerServiceAgentPoolProfile": "Container Service", - "Add-AzureRmVmssWinRMListener": "VM Scale Sets", - "Set-AzureRmVmssRollingUpgradePolicy": "VM Scale Sets", - "Remove-AzureRmVMAEMExtension": "VM Extensions", - "Repair-AzureRmVmssServiceFabricUpdateDomain": "VM Scale Sets", - "Set-AzureRmVMDscExtension": "VM Extensions", - "New-AzureRmContainerServiceConfig": "Container Service", - "Add-AzureRmVMNetworkInterface": "Virtual Machines", - "Update-AzureRmImage": "VM Images", - "Set-AzureRmVmssDiskEncryptionExtension": "VM Scale Sets", - "Update-AzureRmVmss": "VM Scale Sets", - "New-AzureRmVmssIpConfig": "VM Scale Sets", - "Set-AzureRmImageOsDisk": "VM Images", - "Update-AzureRmDisk": "VM Disks", - "Get-AzureRmSnapshot": "VM Snapshots", - "Remove-AzureRMVMSqlServerExtension": "VM Extensions", - "Revoke-AzureRmDiskAccess": "VM Disks", - "New-AzureRmImageConfig": "VM Images", - "Test-AzureRmVMAEMExtension": "VM Extensions", - "Stop-AzureRmVM": "Virtual Machines", - "Set-AzureRmDiskUpdateDiskEncryptionKey": "VM Disks", - "New-AzureRmVM": "Virtual Machines", - "New-AzureRmAvailabilitySet": "Virtual Machines", - "Set-AzureRmVmssBootDiagnostic": "VM Scale Sets", - "Remove-AzureRmImage": "VM Images", - "Set-AzureRmDiskKeyEncryptionKey": "VM Disks", - "Get-AzureRmVmssDiskEncryption": "VM Scale Sets", - "New-AzureRmSnapshotConfig": "VM Snapshots", - "Remove-AzureRmVMDiskEncryptionExtension": "VM Disks", - "Set-AzureRmVMSourceImage": "VM Images", - "Update-AzureRmVmssInstance": "VM Scale Sets", - "Get-AzureRmRemoteDesktopFile": "Virtual Machines", - "Set-AzureRmVMBginfoExtension": "VM Extensions", - "Set-AzureRmSnapshotUpdateDiskEncryptionKey": "VM Snapshots", - "Get-AzureRmComputeResourceSku": "Virtual Machines", - "Get-AzureRmVMExtensionImage": "VM Images", - "Update-AzureRmAvailabilitySet": "Virtual Machines", - "New-AzureRmVMDataDisk": "VM Disks", - "Set-AzureRmVmssVM": "VM Scale Sets", - "Update-AzureRmVmssVM": "VM Scale Sets", - "Remove-AzureRmVMSecret": "Virtual Machines", - "Remove-AzureRmVmssDiagnosticsExtension": "VM Scale Sets", - "New-AzureRmContainerService": "Container Service", - "Remove-AzureRmVmssExtension": "VM Scale Sets", - "New-AzureRmDisk": "VM Disks", - "Get-AzureRmVMRunCommandDocument": "Virtual Machines", - "Remove-AzureRmVMExtension": "VM Extensions", - "Add-AzureRmVmssDataDisk": "VM Scale Sets", - "Add-AzureRmVMSshPublicKey": "Virtual Machines", - "Get-AzureRmVMSize": "Virtual Machines", - "Set-AzureRmSnapshotImageReference": "VM Snapshots", - "Get-AzureRmDisk": "VM Disks", - "Remove-AzureRmVMBackup": "Virtual Machines", - "Export-AzureRmLogAnalyticRequestRateByInterval": "Virtual Machines", - "Get-AzureRmVMCustomScriptExtension": "VM Extensions", - "Add-AzureRmVMSecret": "Virtual Machines", - "Add-AzureRmVMAdditionalUnattendContent": "Virtual Machines", - "Get-AzureRmVMImageOffer": "VM Images", - "Set-AzureRmVmssOsProfile": "VM Scale Sets", - "Set-AzureRmVMChefExtension": "VM Extensions", - "Invoke-AzureRmVMRunCommand": "Virtual Machines", - "Set-AzureRMVMSqlServerExtension": "VM Extensions", - "Get-AzureRmImage": "VM Images", - "Add-AzureRmVmssNetworkInterfaceConfiguration": "VM Scale Sets", - "Set-AzureRmDiskUpdateKeyEncryptionKey": "VM Disks", - "Set-AzureRMVMDataDisk": "VM Disks", - "Add-AzureRmVmssExtension": "VM Scale Sets", - "New-AzureRmVMSqlServerAutoPatchingConfig": "Virtual Machines", - "Remove-AzureRmAvailabilitySet": "Virtual Machines", - "New-AzureRmSnapshot": "VM Snapshots", - "Remove-AzureRmVMDiagnosticsExtension": "VM Extensions", - "Remove-AzureRmImageDataDisk": "VM Images", - "Update-AzureRmContainerService": "Container Service", - "Add-AzureRmVMDataDisk": "VM Disks", - "Start-AzureRmVmssRollingOSUpgrade": "VM Scale Sets", - "Set-AzureRmSnapshotUpdateKeyEncryptionKey": "VM Snapshots", - "Restart-AzureRmVmss": "VM Scale Sets", - "Remove-AzureRmVMAccessExtension": "VM Extensions", - "Get-AzureRmContainerService": "Container Service", - "Grant-AzureRmDiskAccess": "VM Disks", - "Set-AzureRmVMAccessExtension": "VM Extensions", - "Remove-AzureRmVMChefExtension": "VM Extensions", - "Get-AzureRmVMExtensionImageType": "VM Images", - "Restart-AzureRmVM": "Virtual Machines", - "Get-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmSnapshotDiskEncryptionKey": "VM Snapshots", - "Start-AzureRmVmss": "VM Scale Sets", - "Set-AzureRmVmssStorageProfile": "VM Scale Sets", - "Get-AzureRmVMExtension": "VM Extensions", - "New-AzureRmVMSqlServerKeyVaultCredentialConfig": "Virtual Machines", - "New-AzureRmDiskConfig": "VM Disks", - "Remove-AzureRmVmssNetworkInterfaceConfiguration": "VM Scale Sets", - "Get-AzureRmVMUsage": "Virtual Machines", - "Get-AzureRmTag": "Tags", - "Remove-AzureRmTag": "Tags", - "New-AzureRmTag": "Tags", - "Get-AzureRmContext": "Profile", - "Select-AzureRmContext": "Profile", - "Set-AzureRmEnvironment": "Profile", - "Remove-AzureRmEnvironment": "Profile", - "Get-AzureRmContextAutosaveSetting": "Profile", - "Send-Feedback": "Profile", - "Enable-AzureRmContextAutosave": "Profile", - "Disable-AzureRmDataCollection": "Profile", - "Resolve-AzureRmError": "Profile", - "Add-AzureRmEnvironment": "Profile", - "Connect-AzureRmAccount": "Profile", - "Remove-AzureRmContext": "Profile", - "Disconnect-AzureRmAccount": "Profile", - "Set-AzureRmDefault": "Profile", - "Rename-AzureRmContext": "Profile", - "Set-AzureRmContext": "Profile", - "Get-AzureRmDefault": "Profile", - "Get-AzureRmSubscription": "Profile", - "Clear-AzureRmDefault": "Profile", - "Get-AzureRmEnvironment": "Profile", - "Disable-AzureRmContextAutosave": "Profile", - "Get-AzureRmTenant": "Profile", - "Clear-AzureRmContext": "Profile", - "Import-AzureRmContext": "Profile", - "Enable-AzureRmDataCollection": "Profile", - "Save-AzureRmContext": "Profile", - "Remove-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "Set-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Get-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Get-AzureRmVirtualNetworkGatewayBGPPeerStatus": "Virtual Network", - "Get-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "New-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "Set-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "New-AzureRmVpnClientRootCertificate": "VPN", - "Add-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Remove-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Remove-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Get-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "New-AzureRmApplicationGatewaySku": "Application Gateway", - "New-AzureRmLocalNetworkGateway": "Networking", - "Add-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Remove-AzureRmLocalNetworkGateway": "Networking", - "Start-AzureRmNetworkWatcherResourceTroubleshooting": "Network Watcher", - "Get-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "New-AzureRmApplicationSecurityGroup": "Networking", - "New-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Add-AzureRmVpnClientRootCertificate": "VPN", - "Remove-AzureRmNetworkSecurityRuleConfig": "Networking", - "Add-AzureRmVirtualNetworkGatewayIpConfig": "Virtual Network", - "Get-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "New-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "New-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Set-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Remove-AzureRmRouteFilter": "Route", - "Get-AzureRmEffectiveRouteTable": "Route", - "Add-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Set-AzureRmVpnClientIpsecParameter": "VPN", - "Add-AzureRmRouteFilterRuleConfig": "Route", - "Get-AzureRmNetworkWatcherNextHop": "Network Watcher", - "New-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Remove-AzureRmVirtualNetwork": "Virtual Network", - "New-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Set-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Set-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "Start-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Start-AzureRmApplicationGateway": "Application Gateway", - "Get-AzureRmExpressRouteCircuitRouteTableSummary": "ExpressRoute", - "Remove-AzureRmLoadBalancer": "Load Balancer", - "Add-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "Get-AzureRmRouteFilter": "Route", - "Test-AzureRmDnsAvailability": "DNS", - "Get-AzureRmApplicationGateway": "Application Gateway", - "New-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Remove-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Remove-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Remove-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "New-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Set-AzureRmExpressRouteCircuit": "ExpressRoute", - "Set-AzureRmNetworkSecurityGroup": "Networking", - "Add-AzureRmVpnClientRevokedCertificate": "VPN", - "Get-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Get-AzureRmNetworkWatcherSecurityGroupView": "Network Watcher", - "Get-AzureRmRouteFilterRuleConfig": "Route", - "Remove-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Get-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "New-AzureRmRouteFilterRuleConfig": "Route", - "Get-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Get-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Remove-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Add-AzureRmVirtualNetworkPeering": "Virtual Network", - "Set-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Add-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Remove-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Set-AzureRmNetworkInterface": "Networking", - "Get-AzureRmVirtualNetworkGatewayConnectionVpnDeviceConfigScript": "Virtual Network", - "Test-AzureRmPrivateIPAddressAvailability": "Networking", - "Remove-AzureRmExpressRouteCircuit": "ExpressRoute", - "Stop-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "Get-AzureRmApplicationGatewayAvailableSslOptions": "Application Gateway", - "Get-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Remove-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Set-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Resize-AzureRmVirtualNetworkGateway": "Virtual Network", - "Get-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "Add-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Add-AzureRmRouteConfig": "Route", - "Add-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmVirtualNetworkGatewayLearnedRoute": "Virtual Network", - "New-AzureRmNetworkSecurityRuleConfig": "Networking", - "New-AzureRmNetworkWatcherProtocolConfiguration": "Network Watcher", - "New-AzureRmVpnClientConfiguration": "VPN", - "Stop-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Get-AzureRmNetworkWatcherReachabilityProvidersList": "Network Watcher", - "New-AzureRmVpnClientIpsecParameter": "VPN", - "Add-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Add-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Add-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "New-AzureRmIpsecPolicy": "Networking", - "Remove-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Remove-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "New-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Get-AzureRmVirtualNetworkUsageList": "Virtual Network", - "New-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Get-AzureRmNetworkWatcherConnectionMonitorReport": "Network Watcher", - "New-AzureRmNetworkWatcher": "Network Watcher", - "New-AzureRmVpnClientRevokedCertificate": "VPN", - "Set-AzureRmApplicationGatewaySku": "Application Gateway", - "Get-AzureRmVpnClientRevokedCertificate": "VPN", - "Remove-AzureRmRouteConfig": "Route", - "Remove-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Get-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "New-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "New-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "New-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Get-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "New-AzureRmNetworkInterfaceIpConfig": "Networking", - "Set-AzureRmLoadBalancer": "Load Balancer", - "Get-AzureRmBgpServiceCommunity": "Networking", - "Set-AzureRmVirtualNetworkGatewayVpnClientConfig": "Virtual Network", - "Get-AzureRmExpressRouteCircuit": "ExpressRoute", - "New-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "New-AzureRmRouteConfig": "Route", - "Get-AzureRmEffectiveNetworkSecurityGroup": "Networking", - "Get-AzureRmVpnClientPackage": "VPN", - "Remove-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Set-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Get-AzureRmNetworkSecurityRuleConfig": "Networking", - "Remove-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Add-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Get-AzureRmApplicationSecurityGroup": "Networking", - "Remove-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Set-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Get-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Add-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Remove-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Set-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "New-AzureRmLoadBalancerInboundNatPoolConfig": "Load Balancer", - "Remove-AzureRmNetworkInterface": "Networking", - "Set-AzureRmNetworkWatcherConfigFlowLog": "Network Watcher", - "Add-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Set-AzureRmApplicationGatewaySslCertificate": "Application Gateway", - "Get-AzureRmApplicationGatewayBackendHealth": "Application Gateway", - "Set-AzureRmApplicationGateway": "Application Gateway", - "Add-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Set-AzureRmRouteConfig": "Route", - "New-AzureRmVirtualNetwork": "Virtual Network", - "Get-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "New-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "New-AzureRmVpnClientIpsecPolicy": "VPN", - "Stop-AzureRmApplicationGateway": "Application Gateway", - "Remove-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Remove-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "New-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmLocalNetworkGateway": "Networking", - "Get-AzureRmExpressRouteCircuitARPTable": "ExpressRoute", - "Get-AzureRmApplicationGatewaySku": "Application Gateway", - "Remove-AzureRmVirtualNetworkGateway": "Virtual Network", - "New-AzureRmExpressRouteCircuit": "ExpressRoute", - "Remove-AzureRmApplicationGatewayRequestRoutingRule": "Application Gateway", - "New-AzureRmNetworkInterface": "Networking", - "Remove-AzureRmVirtualNetworkGatewayDefaultSite": "Virtual Network", - "New-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Get-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Remove-AzureRmApplicationSecurityGroup": "Networking", - "Get-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Get-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Get-AzureRmNetworkWatcherTopology": "Network Watcher", - "New-AzureRmPacketCaptureFilterConfig": "Networking", - "Add-AzureRmNetworkSecurityRuleConfig": "Networking", - "New-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Set-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Set-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Add-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "New-AzureRmRouteFilter": "Route", - "Remove-AzureRmPublicIpAddress": "Networking", - "Get-AzureRmVpnClientRootCertificate": "VPN", - "Remove-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Get-AzureRmVirtualNetwork": "Virtual Network", - "Remove-AzureRmVpnClientRootCertificate": "VPN", - "Get-AzureRmApplicationGatewayAvailableWafRuleSets": "Application Gateway", - "Remove-AzureRmDdosProtectionPlan": "Networking", - "Add-AzureRmApplicationGatewayIPConfiguration": "Application Gateway", - "Set-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Add-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmVpnClientRevokedCertificate": "VPN", - "Set-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "New-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "New-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Get-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Set-AzureRmVirtualNetwork": "Virtual Network", - "Remove-AzureRmNetworkSecurityGroup": "Networking", - "Get-AzureRmNetworkWatcherConnectionMonitor": "Network Watcher", - "Get-AzureRmNetworkWatcher": "Network Watcher", - "New-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Remove-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Get-AzureRmVpnClientIpsecParameter": "VPN", - "New-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "Test-AzureRmNetworkWatcherConnectivity": "Network Watcher", - "Reset-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "New-AzureRmRouteTable": "Route", - "Set-AzureRmRouteTable": "Route", - "Get-AzureRmRouteTable": "Route", - "Get-AzureRmVirtualNetworkGateway": "Virtual Network", - "New-AzureRmNetworkWatcherPacketCapture": "Network Watcher", - "New-AzureRmNetworkSecurityGroup": "Networking", - "New-AzureRmLoadBalancerInboundNatRuleConfig": "Load Balancer", - "Add-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "New-AzureRmDdosProtectionPlan": "Networking", - "Remove-AzureRmApplicationGateway": "Application Gateway", - "New-AzureRmApplicationGatewayFirewallDisabledRuleGroupConfig": "Application Gateway", - "Get-AzureRmNetworkSecurityGroup": "Networking", - "New-AzureRmApplicationGatewayProbeHealthResponseMatch": "Application Gateway", - "Set-AzureRmApplicationGatewayConnectionDraining": "Application Gateway", - "Get-AzureRmLoadBalancer": "Load Balancer", - "Add-AzureRmApplicationGatewayBackendAddressPool": "Application Gateway", - "Set-AzureRmLocalNetworkGateway": "Networking", - "Get-AzureRmApplicationGatewaySslPredefinedPolicy": "Application Gateway", - "Get-AzureRmNetworkUsage": "Networking", - "Remove-AzureRmNetworkWatcher": "Network Watcher", - "Get-AzureRmLoadBalancerProbeConfig": "Load Balancer", - "Get-AzureRmPublicIpAddress": "Networking", - "Remove-AzureRmRouteTable": "Route", - "Get-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Set-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Set-AzureRmVirtualNetworkSubnetConfig": "Virtual Network", - "Set-AzureRmNetworkSecurityRuleConfig": "Networking", - "Remove-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Get-AzureRmApplicationGatewayUrlPathMapConfig": "Application Gateway", - "Set-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "Get-AzureRmRouteConfig": "Route", - "Set-AzureRmVirtualNetworkGateway": "Virtual Network", - "Set-AzureRmVirtualNetworkGatewayDefaultSite": "Virtual Network", - "Remove-AzureRmVpnClientIpsecParameter": "VPN", - "Remove-AzureRmRouteFilterRuleConfig": "Route", - "Set-AzureRmVirtualNetworkGatewayConnection": "Virtual Network", - "Get-AzureRmVirtualNetworkGatewaySupportedVpnDevice": "Virtual Network", - "Test-AzureRmNetworkWatcherIPFlow": "Network Watcher", - "Move-AzureRmExpressRouteCircuit": "ExpressRoute", - "New-AzureRmPublicIpTag": "Networking", - "Get-AzureRmVirtualNetworkGatewayAdvertisedRoute": "Virtual Network", - "New-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Reset-AzureRmVirtualNetworkGateway": "Virtual Network", - "New-AzureRmPublicIpAddress": "Networking", - "Get-AzureRmNetworkWatcherFlowLogStatus": "Network Watcher", - "Get-AzureRmLoadBalancerRuleConfig": "Load Balancer", - "Get-AzureRmApplicationGatewayWebApplicationFirewallConfiguration": "Application Gateway", - "Add-AzureRmApplicationGatewayProbeConfig": "Application Gateway", - "Add-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "New-AzureRmApplicationGatewayPathRuleConfig": "Application Gateway", - "Set-AzureRmRouteFilterRuleConfig": "Route", - "Get-AzureRmNetworkInterface": "Networking", - "Set-AzureRmRouteFilter": "Route", - "New-AzureRmApplicationGatewayHttpListener": "Application Gateway", - "Add-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Remove-AzureRmApplicationGatewayFrontendIPConfig": "Application Gateway", - "New-AzureRmVirtualNetworkGateway": "Virtual Network", - "Remove-AzureRmVirtualNetworkPeering": "Virtual Network", - "Get-AzureRmDdosProtectionPlan": "Networking", - "Set-AzureRmLoadBalancerFrontendIpConfig": "Load Balancer", - "Get-AzureRmVirtualNetworkPeering": "Virtual Network", - "Remove-AzureRmExpressRouteCircuitConnectionConfig": "ExpressRoute", - "Get-AzureRmVirtualNetworkAvailableEndpointService": "Virtual Network", - "New-AzureRmExpressRouteCircuitAuthorization": "ExpressRoute", - "Get-AzureRMNetworkWatcherReachabilityReport": "Network Watcher", - "Get-AzureRmExpressRouteCircuitStats": "ExpressRoute", - "Set-AzureRmVirtualNetworkGatewayConnectionSharedKey": "Virtual Network", - "Set-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Set-AzureRmApplicationGatewayRedirectConfiguration": "Application Gateway", - "Set-AzureRmPublicIpAddress": "Networking", - "Get-AzureRmNetworkWatcherTroubleshootingResult": "Network Watcher", - "Set-AzureRmApplicationGatewayAuthenticationCertificate": "Application Gateway", - "Get-AzureRmApplicationGatewayFrontendPort": "Application Gateway", - "Remove-AzureRmApplicationGatewayBackendHttpSettings": "Application Gateway", - "Set-AzureRmVirtualNetworkPeering": "Virtual Network", - "Get-AzureRmNetworkInterfaceIpConfig": "Networking", - "Remove-AzureRmNetworkInterfaceIpConfig": "Networking", - "Set-AzureRmApplicationGatewaySslPolicy": "Application Gateway", - "Get-AzureRmExpressRouteServiceProvider": "ExpressRoute", - "Get-AzureRmVpnClientConfiguration": "VPN", - "Remove-AzureRmExpressRouteCircuitPeeringConfig": "ExpressRoute", - "Add-AzureRmLoadBalancerBackendAddressPoolConfig": "Load Balancer", - "Get-AzureRmExpressRouteCircuitRouteTable": "ExpressRoute", - "New-AzureRmApplicationGateway": "Application Gateway", - "New-AzureRmLoadBalancer": "Load Balancer", - "New-AzureRmAlertRuleWebhook": "Monitor", - "New-AzureRmAutoscaleRule": "Monitor", - "New-AzureRmActionGroup": "Monitor", - "Disable-AzureRmActivityLogAlert": "Monitor", - "New-AzureRmAlertRuleEmail": "Monitor", - "Get-AzureRmActionGroup": "Monitor", - "Get-AzureRmActivityLogAlert": "Monitor", - "Get-AzureRmMetricDefinition": "Monitor", - "Remove-AzureRmAutoscaleSetting": "Monitor", - "Remove-AzureRmDiagnosticSetting": "Monitor", - "Remove-AzureRmActivityLogAlert": "Monitor", - "New-AzureRmAutoscaleNotification": "Monitor", - "Get-AzureRmAutoscaleSetting": "Monitor", - "Enable-AzureRmActivityLogAlert": "Monitor", - "Get-AzureRmAutoscaleHistory": "Monitor", - "Remove-AzureRmAlertRule": "Monitor", - "Remove-AzureRmLogProfile": "Monitor", - "New-AzureRmAutoscaleProfile": "Monitor", - "Get-AzureRmDiagnosticSetting": "Monitor", - "Get-AzureRmMetric": "Monitor", - "Add-AzureRmAutoscaleSetting": "Monitor", - "Get-AzureRmLog": "Monitor", - "New-AzureRmActionGroupReceiver": "Monitor", - "Get-AzureRmLogProfile": "Monitor", - "Set-AzureRmActivityLogAlert": "Monitor", - "Add-AzureRmWebtestAlertRule": "Monitor", - "Add-AzureRmMetricAlertRule": "Monitor", - "Remove-AzureRmActionGroup": "Monitor", - "Get-AzureRmAlertHistory": "Monitor", - "Add-AzureRmLogProfile": "Monitor", - "Set-AzureRmActionGroup": "Monitor", - "Get-AzureRmAlertRule": "Monitor", - "New-AzureRmMetricFilter": "Monitor", - "Set-AzureRmDiagnosticSetting": "Monitor", - "New-AzureRmActivityLogAlertCondition": "Monitor", - "New-AzureRmAutoscaleWebhook": "Monitor", - "Remove-AzureStorageCORSRule": "Storage", - "New-AzureStorageShare": "Storage", - "Update-AzureStorageServiceProperty": "Storage", - "Remove-AzureStorageFile": "Storage", - "Get-AzureStorageServiceLoggingProperty": "Storage", - "Get-AzureStorageQueueStoredAccessPolicy": "Storage", - "New-AzureStorageTableSASToken": "Storage", - "Remove-AzureStorageContainer": "Storage", - "New-AzureStorageBlobSASToken": "Storage", - "New-AzureStorageShareSASToken": "Storage", - "Start-AzureStorageBlobCopy": "Storage", - "Get-AzureStorageBlobCopyState": "Storage", - "Start-AzureStorageBlobIncrementalCopy": "Storage", - "Disable-AzureStorageDeleteRetentionPolicy": "Storage", - "Stop-AzureStorageFileCopy": "Storage", - "Set-AzureStorageShareStoredAccessPolicy": "Storage", - "Enable-AzureStorageDeleteRetentionPolicy": "Storage", - "New-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageContainerAcl": "Storage", - "New-AzureStorageDirectory": "Storage", - "Get-AzureStorageServiceMetricsProperty": "Storage", - "Get-AzureStorageTableStoredAccessPolicy": "Storage", - "Set-AzureStorageCORSRule": "Storage", - "Get-AzureStorageBlob": "Storage", - "Get-AzureStorageFileContent": "Storage", - "Start-AzureStorageFileCopy": "Storage", - "Get-AzureStorageFile": "Storage", - "Get-AzureStorageContainerStoredAccessPolicy": "Storage", - "Get-AzureStorageShareStoredAccessPolicy": "Storage", - "Get-AzureStorageTable": "Storage", - "New-AzureStorageShareStoredAccessPolicy": "Storage", - "New-AzureStorageContainer": "Storage", - "New-AzureStorageQueueStoredAccessPolicy": "Storage", - "Remove-AzureStorageDirectory": "Storage", - "Get-AzureStorageBlobContent": "Storage", - "Get-AzureStorageServiceProperty": "Storage", - "Get-AzureStorageCORSRule": "Storage", - "Set-AzureStorageFileContent": "Storage", - "Get-AzureStorageContainer": "Storage", - "New-AzureStorageContainerSASToken": "Storage", - "New-AzureStorageContext": "Storage", - "New-AzureStorageFileSASToken": "Storage", - "Get-AzureStorageShare": "Storage", - "Get-AzureStorageFileCopyState": "Storage", - "Remove-AzureStorageBlob": "Storage", - "New-AzureStorageTable": "Storage", - "New-AzureStorageTableStoredAccessPolicy": "Storage", - "Remove-AzureStorageShareStoredAccessPolicy": "Storage", - "Stop-AzureStorageBlobCopy": "Storage", - "New-AzureStorageQueue": "Storage", - "New-AzureStorageQueueSASToken": "Storage", - "Remove-AzureStorageTable": "Storage", - "Get-AzureStorageQueue": "Storage", - "Remove-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageTableStoredAccessPolicy": "Storage", - "Remove-AzureStorageShare": "Storage", - "Remove-AzureStorageQueue": "Storage", - "New-AzureStorageAccountSASToken": "Storage", - "Remove-AzureStorageTableStoredAccessPolicy": "Storage", - "Set-AzureStorageServiceMetricsProperty": "Storage", - "Set-AzureStorageShareQuota": "Storage", - "Set-AzureStorageContainerStoredAccessPolicy": "Storage", - "Set-AzureStorageBlobContent": "Storage", - "Set-AzureStorageServiceLoggingProperty": "Storage", - "Remove-AzureStorageQueueStoredAccessPolicy": "Storage", - "Set-AzureStorageQueueStoredAccessPolicy": "Storage", - "Add-AzureRmStorageAccountNetworkRule": "Storage", - "Get-AzureRmStorageAccount": "Storage", - "Get-AzureRmStorageAccountKey": "Storage", - "Get-AzureRmStorageAccountNameAvailability": "Storage", - "Get-AzureRmStorageAccountNetworkRuleSet": "Storage", - "Get-AzureRmStorageUsage": "Storage", - "New-AzureRmStorageAccount": "Storage", - "New-AzureRmStorageAccountKey": "Storage", - "Remove-AzureRmStorageAccount": "Storage", - "Remove-AzureRmStorageAccountNetworkRule": "Storage", - "Set-AzureRmCurrentStorageAccount": "Storage", - "Set-AzureRmStorageAccount": "Storage", - "Update-AzureRmStorageAccountNetworkRuleSet": "Storage" - } \ No newline at end of file