Guide

Configuration

Remove-CloudWrapperConfiguration

Suggest Edits

Synopsis

Delete a configuration.

Syntax

Remove-CloudWrapperConfiguration [-ConfigID] <Int32> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Deletes a specific Cloud Wrapper configuration. The delete can take up to three hours to complete.

You can use the configuration's configId to run the Get-CloudWrapperConfiguration operation to check the status. DELETE_IN_PROGRESS indicates the request has been accepted. A 404 response indicates the configuration has been deleted.

Before you delete a configuration, ensure that all the properties that use it have the Cloud Wrapper behavior disabled. Then run the Set-CloudWrapperConfiguration operation to deactivate it by providing the -Deactivate switch.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑ConfigID
Required
Int Pipeline input: ByValue, ByPropertyName

Your Cloud Wrapper configuration's ID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 14 days ago