Remove-AzureRmEnvironment

NAME Remove-AzureRmEnvironment



SYNOPSIS

Removes endpoints and metadata for connecting to a given Azure instance.





SYNTAX

Remove-AzureRmEnvironment [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-Scope {Process | CurrentUser}] [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Remove-AzureRmEnvironment cmdlet removes endpoints and metadata information for connecting to a given Azure instance.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, tenant and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the environment to remove.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Scope <ContextModificationScope>

Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this

user.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

PSAzureEnvironment







NOTES









Example 1: Creating and removing a test environment



PS C:\\> Add-AzureRmEnvironment -Name TestEnvironment `

-ActiveDirectoryEndpoint TestADEndpoint `

-ActiveDirectoryServiceEndpointResourceId TestADApplicationId `

-ResourceManagerEndpoint TestRMEndpoint `

-GalleryEndpoint TestGalleryEndpoint `

-GraphEndpoint TestGraphEndpoint



Name : TestEnvironment

EnableAdfsAuthentication : False

ActiveDirectoryServiceEndpointResourceId : TestADApplicationId

AdTenant :

GalleryUrl : TestGalleryEndpoint

ManagementPortalUrl :

ServiceManagementUrl :

PublishSettingsFileUrl :

ResourceManagerUrl : TestRMEndpoint

SqlDatabaseDnsSuffix :

StorageEndpointSuffix :

ActiveDirectoryAuthority : TestADEndpoint

GraphUrl : TestGraphEndpoint

GraphEndpointResourceId :

TrafficManagerDnsSuffix :

AzureKeyVaultDnsSuffix :

AzureDataLakeStoreFileSystemEndpointSuffix :

AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :

AzureKeyVaultServiceEndpointResourceId :



PS C:\\> Remove-AzureRmEnvironment -Name TestEnvironment



Name : TestEnvironment

EnableAdfsAuthentication : False

ActiveDirectoryServiceEndpointResourceId : TestADApplicationId

AdTenant :

GalleryUrl : TestGalleryEndpoint

ManagementPortalUrl :

ServiceManagementUrl :

PublishSettingsFileUrl :

ResourceManagerUrl : TestRMEndpoint

SqlDatabaseDnsSuffix :

StorageEndpointSuffix :

ActiveDirectoryAuthority : TestADEndpoint

GraphUrl : TestGraphEndpoint

GraphEndpointResourceId :

TrafficManagerDnsSuffix :

AzureKeyVaultDnsSuffix :

AzureDataLakeStoreFileSystemEndpointSuffix :

AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :

AzureKeyVaultServiceEndpointResourceId :



This example shows how to create an environment using Add-AzureRmEnvironment, and then how to delete the environment using

Remove-AzureRmEnvironment.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... nvironment

Add-AzureRmEnvironment

Get-AzureRmEnvironment

Set-AzureRMEnvironment