Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. workloads
  5. getSAPDatabaseInstance
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.workloads.getSAPDatabaseInstance

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the SAP Database Instance resource. Azure REST API version: 2023-04-01.

Other available API versions: 2023-10-01-preview.

Using getSAPDatabaseInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSAPDatabaseInstance(args: GetSAPDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetSAPDatabaseInstanceResult>
function getSAPDatabaseInstanceOutput(args: GetSAPDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetSAPDatabaseInstanceResult>
Copy
def get_sap_database_instance(database_instance_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              sap_virtual_instance_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSAPDatabaseInstanceResult
def get_sap_database_instance_output(database_instance_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              sap_virtual_instance_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSAPDatabaseInstanceResult]
Copy
func LookupSAPDatabaseInstance(ctx *Context, args *LookupSAPDatabaseInstanceArgs, opts ...InvokeOption) (*LookupSAPDatabaseInstanceResult, error)
func LookupSAPDatabaseInstanceOutput(ctx *Context, args *LookupSAPDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupSAPDatabaseInstanceResultOutput
Copy

> Note: This function is named LookupSAPDatabaseInstance in the Go SDK.

public static class GetSAPDatabaseInstance 
{
    public static Task<GetSAPDatabaseInstanceResult> InvokeAsync(GetSAPDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetSAPDatabaseInstanceResult> Invoke(GetSAPDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSAPDatabaseInstanceResult> getSAPDatabaseInstance(GetSAPDatabaseInstanceArgs args, InvokeOptions options)
public static Output<GetSAPDatabaseInstanceResult> getSAPDatabaseInstance(GetSAPDatabaseInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:workloads:getSAPDatabaseInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Database resource name string modeled as parameter for auto generation to work correctly.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SapVirtualInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Instances for SAP solutions resource
DatabaseInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Database resource name string modeled as parameter for auto generation to work correctly.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SapVirtualInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Instances for SAP solutions resource
databaseInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Database resource name string modeled as parameter for auto generation to work correctly.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sapVirtualInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Instances for SAP solutions resource
databaseInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Database resource name string modeled as parameter for auto generation to work correctly.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sapVirtualInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Virtual Instances for SAP solutions resource
database_instance_name
This property is required.
Changes to this property will trigger replacement.
str
Database resource name string modeled as parameter for auto generation to work correctly.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
sap_virtual_instance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Virtual Instances for SAP solutions resource
databaseInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Database resource name string modeled as parameter for auto generation to work correctly.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sapVirtualInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Virtual Instances for SAP solutions resource

getSAPDatabaseInstance Result

The following output properties are available:

DatabaseSid string
Database SID name.
DatabaseType string
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
Errors Pulumi.AzureNative.Workloads.Outputs.SAPVirtualInstanceErrorResponse
Defines the errors related to Database resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IpAddress string
Database IP Address.
LoadBalancerDetails Pulumi.AzureNative.Workloads.Outputs.LoadBalancerDetailsResponse
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Defines the provisioning states.
Status string
Defines the SAP Instance status.
Subnet string
Database subnet.
SystemData Pulumi.AzureNative.Workloads.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VmDetails List<Pulumi.AzureNative.Workloads.Outputs.DatabaseVmDetailsResponse>
The list of virtual machines corresponding to the Database resource.
Tags Dictionary<string, string>
Resource tags.
DatabaseSid string
Database SID name.
DatabaseType string
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
Errors SAPVirtualInstanceErrorResponse
Defines the errors related to Database resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IpAddress string
Database IP Address.
LoadBalancerDetails LoadBalancerDetailsResponse
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Defines the provisioning states.
Status string
Defines the SAP Instance status.
Subnet string
Database subnet.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VmDetails []DatabaseVmDetailsResponse
The list of virtual machines corresponding to the Database resource.
Tags map[string]string
Resource tags.
databaseSid String
Database SID name.
databaseType String
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors SAPVirtualInstanceErrorResponse
Defines the errors related to Database resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ipAddress String
Database IP Address.
loadBalancerDetails LoadBalancerDetailsResponse
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Defines the provisioning states.
status String
Defines the SAP Instance status.
subnet String
Database subnet.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmDetails List<DatabaseVmDetailsResponse>
The list of virtual machines corresponding to the Database resource.
tags Map<String,String>
Resource tags.
databaseSid string
Database SID name.
databaseType string
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors SAPVirtualInstanceErrorResponse
Defines the errors related to Database resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ipAddress string
Database IP Address.
loadBalancerDetails LoadBalancerDetailsResponse
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Defines the provisioning states.
status string
Defines the SAP Instance status.
subnet string
Database subnet.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmDetails DatabaseVmDetailsResponse[]
The list of virtual machines corresponding to the Database resource.
tags {[key: string]: string}
Resource tags.
database_sid str
Database SID name.
database_type str
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors SAPVirtualInstanceErrorResponse
Defines the errors related to Database resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ip_address str
Database IP Address.
load_balancer_details LoadBalancerDetailsResponse
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Defines the provisioning states.
status str
Defines the SAP Instance status.
subnet str
Database subnet.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vm_details Sequence[DatabaseVmDetailsResponse]
The list of virtual machines corresponding to the Database resource.
tags Mapping[str, str]
Resource tags.
databaseSid String
Database SID name.
databaseType String
Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.
errors Property Map
Defines the errors related to Database resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ipAddress String
Database IP Address.
loadBalancerDetails Property Map
The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Defines the provisioning states.
status String
Defines the SAP Instance status.
subnet String
Database subnet.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmDetails List<Property Map>
The list of virtual machines corresponding to the Database resource.
tags Map<String>
Resource tags.

Supporting Types

DatabaseVmDetailsResponse

Status This property is required. string
Defines the SAP Instance status.
StorageDetails This property is required. List<Pulumi.AzureNative.Workloads.Inputs.StorageInformationResponse>
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
VirtualMachineId This property is required. string
Status This property is required. string
Defines the SAP Instance status.
StorageDetails This property is required. []StorageInformationResponse
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
VirtualMachineId This property is required. string
status This property is required. String
Defines the SAP Instance status.
storageDetails This property is required. List<StorageInformationResponse>
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
virtualMachineId This property is required. String
status This property is required. string
Defines the SAP Instance status.
storageDetails This property is required. StorageInformationResponse[]
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
virtualMachineId This property is required. string
status This property is required. str
Defines the SAP Instance status.
storage_details This property is required. Sequence[StorageInformationResponse]
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
virtual_machine_id This property is required. str
status This property is required. String
Defines the SAP Instance status.
storageDetails This property is required. List<Property Map>
Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.
virtualMachineId This property is required. String

ErrorDefinitionResponse

Code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
Details This property is required. List<Pulumi.AzureNative.Workloads.Inputs.ErrorDefinitionResponse>
Internal error details.
Message This property is required. string
Description of the error.
Recommendation This property is required. string
Description of the recommendation.
Code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
Details This property is required. []ErrorDefinitionResponse
Internal error details.
Message This property is required. string
Description of the error.
Recommendation This property is required. string
Description of the recommendation.
code This property is required. String
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. List<ErrorDefinitionResponse>
Internal error details.
message This property is required. String
Description of the error.
recommendation This property is required. String
Description of the recommendation.
code This property is required. string
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. ErrorDefinitionResponse[]
Internal error details.
message This property is required. string
Description of the error.
recommendation This property is required. string
Description of the recommendation.
code This property is required. str
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. Sequence[ErrorDefinitionResponse]
Internal error details.
message This property is required. str
Description of the error.
recommendation This property is required. str
Description of the recommendation.
code This property is required. String
Service specific error code which serves as the substatus for the HTTP error code.
details This property is required. List<Property Map>
Internal error details.
message This property is required. String
Description of the error.
recommendation This property is required. String
Description of the recommendation.

LoadBalancerDetailsResponse

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

SAPVirtualInstanceErrorResponse

Properties ErrorDefinitionResponse
The Virtual Instance for SAP error body.
properties ErrorDefinitionResponse
The Virtual Instance for SAP error body.
properties ErrorDefinitionResponse
The Virtual Instance for SAP error body.
properties ErrorDefinitionResponse
The Virtual Instance for SAP error body.
properties Property Map
The Virtual Instance for SAP error body.

StorageInformationResponse

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native