Stop-AzWorkloadsSapDatabaseInstance
Stops the database instance of the SAP system.
Syntax
Stop-AzWorkloadsSapDatabaseInstance
-Name <String>
-ResourceGroupName <String>
-SapVirtualInstanceName <String>
[-SubscriptionId <String>]
[-DeallocateVM]
[-SoftStopTimeoutSecond <Int64>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Stop-AzWorkloadsSapDatabaseInstance
-InputObject <ISapVirtualInstanceIdentity>
[-DeallocateVM]
[-SoftStopTimeoutSecond <Int64>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Stops the database instance of the SAP system.
Examples
Example 1: Stop Database instance of the SAP system
Stop-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0
AdditionalInfo :
Code :
Detail :
EndTime : 15-03-2023 08:45:40
Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e
77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Message :
Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Operation :
PercentComplete :
ResourceGroupName :
StartTime : 15-03-2023 08:43:32
Status : Succeeded
Target :
Stop-AzWorkloadsSapDatabaseInstance cmdlet stops the Database instance of the SAP system represented by the VIS. Currently stop action is supported for SAP HANA Database only. In this example, you can see that database can be stopped by passing the DB instance resource name, ResourceGroupName and VIS name as inputs.
Example 2: Stop Database instance of the SAP system
Stop-AzWorkloadsSapDatabaseInstance -InputObject /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/resourceGroups/db0-vis-rg/providers/Microsoft.Workloads/sapVirtualInstances/DB0/databaseInstances/db0
AdditionalInfo :
Code :
Detail :
EndTime : 15-03-2023 08:45:40
Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e
77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Message :
Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Operation :
PercentComplete :
ResourceGroupName :
StartTime : 15-03-2023 08:43:32
Status : Succeeded
Target :
Stop-AzWorkloadsSapDatabaseInstance cmdlet stops the Database instance of the SAP system represented by the VIS. Currently stop action is supported for SAP HANA Database only. In this example, you can see that database can be stopped by providing the DB instance Azure resource ID as InputObject to the cmdlet.
Example 3: Stop Database instance of the SAP system and its underlying Virtual Machine
Stop-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 -DeallocateVM
AdditionalInfo :
Code :
Detail :
EndTime : 15-03-2023 08:45:40
Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e
77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Message :
Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Operation :
PercentComplete :
ResourceGroupName :
StartTime : 15-03-2023 08:43:32
Status : Succeeded
Target :
Stop-AzWorkloadsSapDatabaseInstance cmdlet stops the Database instance of the SAP system and its underlying Virtual Machine represented by the VIS. Currently stop action is supported for SAP HANA Database only. In this example, you can see that database and its VMs can be stopped by passing the DB instance resource name, ResourceGroupName, VIS name and DeallocateVM parameter as inputs.
Example 1: Soft Stop Database instance of the SAP system
Stop-AzWorkloadsSapDatabaseInstance -Name db0 -ResourceGroupName db0-vis-rg -SapVirtualInstanceName DB0 -SoftStopTimeoutSecond 300
AdditionalInfo :
Code :
Detail :
EndTime : 15-03-2023 08:45:40
Id : /subscriptions/49d64d54-e966-4c46-a868-1999802b762c/providers/Microsoft.Workloads/locations/CENTRALUSEUAP/operationStatuses/881d4ff9-1d38-4596-b215-28e
77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Message :
Name : 881d4ff9-1d38-4596-b215-28e77dbfe176*DF20ACAC495F17B1D0D9182C3A4C44BC6EDFF718387348FAE17F19BCB5DE687C
Operation :
PercentComplete :
ResourceGroupName :
StartTime : 15-03-2023 08:43:32
Status : Succeeded
Target :
Stop-AzWorkloadsSapDatabaseInstance cmdlet Soft stops the Database instance of the SAP system represented by the VIS. Currently stop action is supported for SAP HANA Database only. In this example, you can see that database can be soft stopped by passing the DB instance resource name, ResourceGroupName, VIS name and soft stop timeout seconds as inputs.
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeallocateVM
The boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | ISapVirtualInstanceIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Database resource name string modeled as parameter for auto generation to work correctly.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SapVirtualInstanceName
The name of the Virtual Instances for SAP solutions resource
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SoftStopTimeoutSecond
This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. hard stop.
Type: | Int64 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Notes
ALIASES
Stop-AzVISDatabaseInstance
Azure PowerShell