Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The monitors/providerInstances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Workloads/monitors/providerInstances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Workloads/monitors/providerInstances@2024-02-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
providerSettings: {
providerType: 'string'
// For remaining properties, see ProviderSpecificProperties objects
}
}
}
ProviderSpecificProperties objects
Set the providerType property to specify the type of object.
For Db2, use:
{
dbName: 'string'
dbPassword: 'string'
dbPasswordUri: 'string'
dbPort: 'string'
dbUsername: 'string'
hostname: 'string'
providerType: 'Db2'
sapSid: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
For MsSqlServer, use:
{
dbPassword: 'string'
dbPasswordUri: 'string'
dbPort: 'string'
dbUsername: 'string'
hostname: 'string'
providerType: 'MsSqlServer'
sapSid: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
For Oracle, use:
{
dbName: 'string'
dbPassword: 'string'
dbPasswordUri: 'string'
dbPort: 'string'
dbUsername: 'string'
hostname: 'string'
providerType: 'Oracle'
sapSid: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
For PrometheusHaCluster, use:
{
clusterName: 'string'
hostname: 'string'
prometheusUrl: 'string'
providerType: 'PrometheusHaCluster'
sid: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
For PrometheusOS, use:
{
prometheusUrl: 'string'
providerType: 'PrometheusOS'
sapSid: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
For SapHana, use:
{
dbName: 'string'
dbPassword: 'string'
dbPasswordUri: 'string'
dbUsername: 'string'
hostname: 'string'
instanceNumber: 'string'
providerType: 'SapHana'
sapSid: 'string'
sqlPort: 'string'
sslCertificateUri: 'string'
sslHostNameInCertificate: 'string'
sslPreference: 'string'
}
For SapNetWeaver, use:
{
providerType: 'SapNetWeaver'
sapClientId: 'string'
sapHostFileEntries: [
'string'
]
sapHostname: 'string'
sapInstanceNr: 'string'
sapPassword: 'string'
sapPasswordUri: 'string'
sapPortNumber: 'string'
sapSid: 'string'
sapUsername: 'string'
sslCertificateUri: 'string'
sslPreference: 'string'
}
Property Values
Microsoft.Workloads/monitors/providerInstances
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: monitors |
| properties | The resource-specific properties for this resource. | ProviderInstanceProperties |
Db2ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the db2 database name. | string |
| dbPassword | Gets or sets the db2 database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the db2 database sql port. | string |
| dbUsername | Gets or sets the db2 database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Db2' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB2 Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
HanaDbProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the hana database name. | string |
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the target virtual machine size. | string |
| instanceNumber | Gets or sets the database instance number. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'SapHana' (required) |
| sapSid | Gets or sets the SAP System Identifier. | string |
| sqlPort | Gets or sets the database sql port. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB. | string |
| sslHostNameInCertificate | Gets or sets the hostname(s) in the SSL certificate. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
MsSqlServerProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the database sql port. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the SQL server host name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'MsSqlServer' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SQL Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
OracleProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the oracle database name. | string |
| dbPassword | Gets or sets the oracle database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the oracle database sql port. | string |
| dbUsername | Gets or sets the oracle database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Oracle' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the Oracle Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusHaClusterProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the clusterName. | string |
| hostname | Gets or sets the target machine name. | string |
| prometheusUrl | URL of the Node Exporter endpoint. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusHaCluster' (required) |
| sid | Gets or sets the cluster sid. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the HA cluster exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusOsProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| prometheusUrl | URL of the Node Exporter endpoint | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusOS' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the prometheus node exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerSettings | Defines the provider specific properties. | ProviderSpecificProperties |
ProviderSpecificProperties
| Name | Description | Value |
|---|---|---|
| providerType | Set to 'Db2' for type Db2ProviderInstanceProperties. Set to 'MsSqlServer' for type MsSqlServerProviderInstanceProperties. Set to 'Oracle' for type OracleProviderInstanceProperties. Set to 'PrometheusHaCluster' for type PrometheusHaClusterProviderInstanceProperties. Set to 'PrometheusOS' for type PrometheusOsProviderInstanceProperties. Set to 'SapHana' for type HanaDbProviderInstanceProperties. Set to 'SapNetWeaver' for type SapNetWeaverProviderInstanceProperties. | 'Db2' 'MsSqlServer' 'Oracle' 'PrometheusHaCluster' 'PrometheusOS' 'SapHana' 'SapNetWeaver' (required) |
SapNetWeaverProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerType | The provider type. For example, the value can be SapHana. | 'SapNetWeaver' (required) |
| sapClientId | Gets or sets the SAP Client ID. | string |
| sapHostFileEntries | Gets or sets the list of HostFile Entries | string[] |
| sapHostname | Gets or sets the target virtual machine IP Address/FQDN. | string |
| sapInstanceNr | Gets or sets the instance number of SAP NetWeaver. | string |
| sapPassword | Sets the SAP password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sapPasswordUri | Gets or sets the key vault URI to secret with the SAP password. | string |
| sapPortNumber | Gets or sets the SAP HTTP port number. | string |
| sapSid | Gets or sets the SAP System Identifier | string |
| sapUsername | Gets or sets the SAP user name. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SAP system. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
ARM template resource definition
The monitors/providerInstances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Workloads/monitors/providerInstances resource, add the following JSON to your template.
{
"type": "Microsoft.Workloads/monitors/providerInstances",
"apiVersion": "2024-02-01-preview",
"name": "string",
"properties": {
"providerSettings": {
"providerType": "string"
// For remaining properties, see ProviderSpecificProperties objects
}
}
}
ProviderSpecificProperties objects
Set the providerType property to specify the type of object.
For Db2, use:
{
"dbName": "string",
"dbPassword": "string",
"dbPasswordUri": "string",
"dbPort": "string",
"dbUsername": "string",
"hostname": "string",
"providerType": "Db2",
"sapSid": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
For MsSqlServer, use:
{
"dbPassword": "string",
"dbPasswordUri": "string",
"dbPort": "string",
"dbUsername": "string",
"hostname": "string",
"providerType": "MsSqlServer",
"sapSid": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
For Oracle, use:
{
"dbName": "string",
"dbPassword": "string",
"dbPasswordUri": "string",
"dbPort": "string",
"dbUsername": "string",
"hostname": "string",
"providerType": "Oracle",
"sapSid": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
For PrometheusHaCluster, use:
{
"clusterName": "string",
"hostname": "string",
"prometheusUrl": "string",
"providerType": "PrometheusHaCluster",
"sid": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
For PrometheusOS, use:
{
"prometheusUrl": "string",
"providerType": "PrometheusOS",
"sapSid": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
For SapHana, use:
{
"dbName": "string",
"dbPassword": "string",
"dbPasswordUri": "string",
"dbUsername": "string",
"hostname": "string",
"instanceNumber": "string",
"providerType": "SapHana",
"sapSid": "string",
"sqlPort": "string",
"sslCertificateUri": "string",
"sslHostNameInCertificate": "string",
"sslPreference": "string"
}
For SapNetWeaver, use:
{
"providerType": "SapNetWeaver",
"sapClientId": "string",
"sapHostFileEntries": [ "string" ],
"sapHostname": "string",
"sapInstanceNr": "string",
"sapPassword": "string",
"sapPasswordUri": "string",
"sapPortNumber": "string",
"sapSid": "string",
"sapUsername": "string",
"sslCertificateUri": "string",
"sslPreference": "string"
}
Property Values
Microsoft.Workloads/monitors/providerInstances
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-02-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| properties | The resource-specific properties for this resource. | ProviderInstanceProperties |
| type | The resource type | 'Microsoft.Workloads/monitors/providerInstances' |
Db2ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the db2 database name. | string |
| dbPassword | Gets or sets the db2 database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the db2 database sql port. | string |
| dbUsername | Gets or sets the db2 database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Db2' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB2 Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
HanaDbProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the hana database name. | string |
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the target virtual machine size. | string |
| instanceNumber | Gets or sets the database instance number. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'SapHana' (required) |
| sapSid | Gets or sets the SAP System Identifier. | string |
| sqlPort | Gets or sets the database sql port. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB. | string |
| sslHostNameInCertificate | Gets or sets the hostname(s) in the SSL certificate. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
MsSqlServerProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the database sql port. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the SQL server host name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'MsSqlServer' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SQL Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
OracleProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the oracle database name. | string |
| dbPassword | Gets or sets the oracle database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the oracle database sql port. | string |
| dbUsername | Gets or sets the oracle database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Oracle' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the Oracle Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusHaClusterProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the clusterName. | string |
| hostname | Gets or sets the target machine name. | string |
| prometheusUrl | URL of the Node Exporter endpoint. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusHaCluster' (required) |
| sid | Gets or sets the cluster sid. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the HA cluster exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusOsProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| prometheusUrl | URL of the Node Exporter endpoint | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusOS' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the prometheus node exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerSettings | Defines the provider specific properties. | ProviderSpecificProperties |
ProviderSpecificProperties
| Name | Description | Value |
|---|---|---|
| providerType | Set to 'Db2' for type Db2ProviderInstanceProperties. Set to 'MsSqlServer' for type MsSqlServerProviderInstanceProperties. Set to 'Oracle' for type OracleProviderInstanceProperties. Set to 'PrometheusHaCluster' for type PrometheusHaClusterProviderInstanceProperties. Set to 'PrometheusOS' for type PrometheusOsProviderInstanceProperties. Set to 'SapHana' for type HanaDbProviderInstanceProperties. Set to 'SapNetWeaver' for type SapNetWeaverProviderInstanceProperties. | 'Db2' 'MsSqlServer' 'Oracle' 'PrometheusHaCluster' 'PrometheusOS' 'SapHana' 'SapNetWeaver' (required) |
SapNetWeaverProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerType | The provider type. For example, the value can be SapHana. | 'SapNetWeaver' (required) |
| sapClientId | Gets or sets the SAP Client ID. | string |
| sapHostFileEntries | Gets or sets the list of HostFile Entries | string[] |
| sapHostname | Gets or sets the target virtual machine IP Address/FQDN. | string |
| sapInstanceNr | Gets or sets the instance number of SAP NetWeaver. | string |
| sapPassword | Sets the SAP password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sapPasswordUri | Gets or sets the key vault URI to secret with the SAP password. | string |
| sapPortNumber | Gets or sets the SAP HTTP port number. | string |
| sapSid | Gets or sets the SAP System Identifier | string |
| sapUsername | Gets or sets the SAP user name. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SAP system. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
Usage Examples
Terraform (AzAPI provider) resource definition
The monitors/providerInstances resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Workloads/monitors/providerInstances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Workloads/monitors/providerInstances@2024-02-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
providerSettings = {
providerType = "string"
// For remaining properties, see ProviderSpecificProperties objects
}
}
}
}
ProviderSpecificProperties objects
Set the providerType property to specify the type of object.
For Db2, use:
{
dbName = "string"
dbPassword = "string"
dbPasswordUri = "string"
dbPort = "string"
dbUsername = "string"
hostname = "string"
providerType = "Db2"
sapSid = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
For MsSqlServer, use:
{
dbPassword = "string"
dbPasswordUri = "string"
dbPort = "string"
dbUsername = "string"
hostname = "string"
providerType = "MsSqlServer"
sapSid = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
For Oracle, use:
{
dbName = "string"
dbPassword = "string"
dbPasswordUri = "string"
dbPort = "string"
dbUsername = "string"
hostname = "string"
providerType = "Oracle"
sapSid = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
For PrometheusHaCluster, use:
{
clusterName = "string"
hostname = "string"
prometheusUrl = "string"
providerType = "PrometheusHaCluster"
sid = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
For PrometheusOS, use:
{
prometheusUrl = "string"
providerType = "PrometheusOS"
sapSid = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
For SapHana, use:
{
dbName = "string"
dbPassword = "string"
dbPasswordUri = "string"
dbUsername = "string"
hostname = "string"
instanceNumber = "string"
providerType = "SapHana"
sapSid = "string"
sqlPort = "string"
sslCertificateUri = "string"
sslHostNameInCertificate = "string"
sslPreference = "string"
}
For SapNetWeaver, use:
{
providerType = "SapNetWeaver"
sapClientId = "string"
sapHostFileEntries = [
"string"
]
sapHostname = "string"
sapInstanceNr = "string"
sapPassword = "string"
sapPasswordUri = "string"
sapPortNumber = "string"
sapSid = "string"
sapUsername = "string"
sslCertificateUri = "string"
sslPreference = "string"
}
Property Values
Microsoft.Workloads/monitors/providerInstances
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: monitors |
| properties | The resource-specific properties for this resource. | ProviderInstanceProperties |
| type | The resource type | "Microsoft.Workloads/monitors/providerInstances@2024-02-01-preview" |
Db2ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the db2 database name. | string |
| dbPassword | Gets or sets the db2 database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the db2 database sql port. | string |
| dbUsername | Gets or sets the db2 database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Db2' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB2 Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
HanaDbProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the hana database name. | string |
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the target virtual machine size. | string |
| instanceNumber | Gets or sets the database instance number. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'SapHana' (required) |
| sapSid | Gets or sets the SAP System Identifier. | string |
| sqlPort | Gets or sets the database sql port. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the DB. | string |
| sslHostNameInCertificate | Gets or sets the hostname(s) in the SSL certificate. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
MsSqlServerProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbPassword | Gets or sets the database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the database sql port. | string |
| dbUsername | Gets or sets the database user name. | string |
| hostname | Gets or sets the SQL server host name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'MsSqlServer' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SQL Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
OracleProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| dbName | Gets or sets the oracle database name. | string |
| dbPassword | Gets or sets the oracle database password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| dbPasswordUri | Gets or sets the key vault URI to secret with the database password. | string |
| dbPort | Gets or sets the oracle database sql port. | string |
| dbUsername | Gets or sets the oracle database user name. | string |
| hostname | Gets or sets the target virtual machine name. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'Oracle' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the Oracle Database. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusHaClusterProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| clusterName | Gets or sets the clusterName. | string |
| hostname | Gets or sets the target machine name. | string |
| prometheusUrl | URL of the Node Exporter endpoint. | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusHaCluster' (required) |
| sid | Gets or sets the cluster sid. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the HA cluster exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
PrometheusOsProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| prometheusUrl | URL of the Node Exporter endpoint | string |
| providerType | The provider type. For example, the value can be SapHana. | 'PrometheusOS' (required) |
| sapSid | Gets or sets the SAP System Identifier | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the prometheus node exporter. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |
ProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerSettings | Defines the provider specific properties. | ProviderSpecificProperties |
ProviderSpecificProperties
| Name | Description | Value |
|---|---|---|
| providerType | Set to 'Db2' for type Db2ProviderInstanceProperties. Set to 'MsSqlServer' for type MsSqlServerProviderInstanceProperties. Set to 'Oracle' for type OracleProviderInstanceProperties. Set to 'PrometheusHaCluster' for type PrometheusHaClusterProviderInstanceProperties. Set to 'PrometheusOS' for type PrometheusOsProviderInstanceProperties. Set to 'SapHana' for type HanaDbProviderInstanceProperties. Set to 'SapNetWeaver' for type SapNetWeaverProviderInstanceProperties. | 'Db2' 'MsSqlServer' 'Oracle' 'PrometheusHaCluster' 'PrometheusOS' 'SapHana' 'SapNetWeaver' (required) |
SapNetWeaverProviderInstanceProperties
| Name | Description | Value |
|---|---|---|
| providerType | The provider type. For example, the value can be SapHana. | 'SapNetWeaver' (required) |
| sapClientId | Gets or sets the SAP Client ID. | string |
| sapHostFileEntries | Gets or sets the list of HostFile Entries | string[] |
| sapHostname | Gets or sets the target virtual machine IP Address/FQDN. | string |
| sapInstanceNr | Gets or sets the instance number of SAP NetWeaver. | string |
| sapPassword | Sets the SAP password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sapPasswordUri | Gets or sets the key vault URI to secret with the SAP password. | string |
| sapPortNumber | Gets or sets the SAP HTTP port number. | string |
| sapSid | Gets or sets the SAP System Identifier | string |
| sapUsername | Gets or sets the SAP user name. | string |
| sslCertificateUri | Gets or sets the blob URI to SSL certificate for the SAP system. | string |
| sslPreference | Gets or sets certificate preference if secure communication is enabled. | 'Disabled' 'RootCertificate' 'ServerCertificate' |