Edit

Share via

Remove-AzWorkloadsSapVirtualInstance

Module:
Az.Workloads Module

Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.

Syntax

Delete (Default) 

Remove-AzWorkloadsSapVirtualInstance
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteViaIdentity 

Remove-AzWorkloadsSapVirtualInstance
    -InputObject <ISapVirtualInstanceIdentity>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.

Examples

Example 1: Remove a Virtual Instance for SAP solutions (VIS)

Remove-AzWorkloadsSapVirtualInstance -Name X51 -ResourceGroupName X51Test

AdditionalInfo    :
Code              :
Detail            :
EndTime           :
Id                : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/EASTUS/operationStatuses/1433bd12-7bb0-403d-a11c-31194d7bd4
                    f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8
Message           :
Name              : 1433bd12-7bb0-403d-a11c-31194d7bd4f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8
Operation         :
PercentComplete   :
ResourceGroupName :
StartTime         : 15-03-2023 14:50:32
Status            : Succeeded
Target            :

Remove-AzWorkloadsSapVirtualInstance cmdlet deletes the VIS, associated child instances (ASCS, Application Instance and Database Instance) and Managed Resource Group. This action doesnt delete the underlying physical Infrastructure resources such as Application resource group and underlying components such as Virtual Machines, Disks, etc. Its required that customer deletes physical resources themselves. Delete of a VIS is permanent action and cannot be reverted. In this example, you can see that VIS can be deleted by passing the VIS name and Resource Group as inputs.

Example 2: Remove a Virtual Instance for SAP solutions (VIS)

Remove-AzWorkloadsSapVirtualInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/X51Test/providers/Microsoft.Workloads/sapVirtualInstances/X51

AdditionalInfo    :
Code              :
Detail            :
EndTime           :
Id                : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/EASTUS/operationStatuses/1433bd12-7bb0-403d-a11c-31194d7bd4
                    f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8
Message           :
Name              : 1433bd12-7bb0-403d-a11c-31194d7bd4f2*619F4904A0186D89AC80F440FBACD91E1EBCEBE959C0A31F7160ABF29816CAF8
Operation         :
PercentComplete   :
ResourceGroupName :
StartTime         : 15-03-2023 14:50:32
Status            : Succeeded
Target            :

Remove-AzWorkloadsSapVirtualInstance cmdlet deletes the VIS, associated child instances (ASCS, Application Instance and Database Instance) and Managed Resource Group. This action doesnt delete the underlying physical Infrastructure resources such as Application resource group and underlying components such as Virtual Machines, Disks, etc. Its required that customer deletes physical resources themselves. Delete of a VIS is permanent action and cannot be reverted. In this example, you can see that VIS can be deleted by passing the Virtual Instance for SAP solutions (VIS) Azure resource ID as InputObject to the cmdlet.

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:ISapVirtualInstanceIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DeleteViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the Virtual Instances for SAP solutions resource

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SapVirtualInstanceName

Parameter sets

Delete
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoWait

Run the command asynchronously

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Delete
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

Delete
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

ISapVirtualInstanceIdentity

Outputs

Boolean

Notes

ALIASES

Remove-AzVIS