1. Packages
  2. Azure Native v2
  3. API Docs
  4. workloads
  5. getMonitor
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

azure-native-v2.workloads.getMonitor

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

Gets properties of a SAP monitor for the specified subscription, resource group, and resource name. Azure REST API version: 2023-04-01.

Other available API versions: 2023-12-01-preview, 2024-02-01-preview.

Using getMonitor

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 getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>
Copy
def get_monitor(monitor_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetMonitorResult
def get_monitor_output(monitor_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]
Copy
func LookupMonitor(ctx *Context, args *LookupMonitorArgs, opts ...InvokeOption) (*LookupMonitorResult, error)
func LookupMonitorOutput(ctx *Context, args *LookupMonitorOutputArgs, opts ...InvokeOption) LookupMonitorResultOutput
Copy

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

public static class GetMonitor 
{
    public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
public static Output<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:workloads:getMonitor
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SAP monitor resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SAP monitor resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Name of the SAP monitor resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
monitorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the SAP monitor resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
monitor_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the SAP monitor resource.
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.
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Name of the SAP monitor resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getMonitor Result

The following output properties are available:

Errors Pulumi.AzureNative.Workloads.Outputs.MonitorPropertiesResponseErrors
Defines the SAP monitor errors.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
MsiArmId string
The ARM ID of the MSI used for SAP monitoring.
Name string
The name of the resource
ProvisioningState string
State of provisioning of the SAP monitor.
StorageAccountArmId string
The ARM ID of the Storage account used for SAP monitoring.
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"
AppLocation string
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
Identity Pulumi.AzureNative.Workloads.Outputs.UserAssignedServiceIdentityResponse
[currently not in use] Managed service identity(user assigned identities)
LogAnalyticsWorkspaceArmId string
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
ManagedResourceGroupConfiguration Pulumi.AzureNative.Workloads.Outputs.ManagedRGConfigurationResponse
Managed resource group configuration
MonitorSubnet string
The subnet which the SAP monitor will be deployed in
RoutingPreference string
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
Tags Dictionary<string, string>
Resource tags.
ZoneRedundancyPreference string
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.
Errors MonitorPropertiesResponseErrors
Defines the SAP monitor errors.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
MsiArmId string
The ARM ID of the MSI used for SAP monitoring.
Name string
The name of the resource
ProvisioningState string
State of provisioning of the SAP monitor.
StorageAccountArmId string
The ARM ID of the Storage account used for SAP monitoring.
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"
AppLocation string
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
Identity UserAssignedServiceIdentityResponse
[currently not in use] Managed service identity(user assigned identities)
LogAnalyticsWorkspaceArmId string
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
ManagedResourceGroupConfiguration ManagedRGConfigurationResponse
Managed resource group configuration
MonitorSubnet string
The subnet which the SAP monitor will be deployed in
RoutingPreference string
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
Tags map[string]string
Resource tags.
ZoneRedundancyPreference string
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.
errors MonitorPropertiesResponseErrors
Defines the SAP monitor errors.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
msiArmId String
The ARM ID of the MSI used for SAP monitoring.
name String
The name of the resource
provisioningState String
State of provisioning of the SAP monitor.
storageAccountArmId String
The ARM ID of the Storage account used for SAP monitoring.
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"
appLocation String
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
identity UserAssignedServiceIdentityResponse
[currently not in use] Managed service identity(user assigned identities)
logAnalyticsWorkspaceArmId String
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration ManagedRGConfigurationResponse
Managed resource group configuration
monitorSubnet String
The subnet which the SAP monitor will be deployed in
routingPreference String
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
tags Map<String,String>
Resource tags.
zoneRedundancyPreference String
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.
errors MonitorPropertiesResponseErrors
Defines the SAP monitor errors.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
msiArmId string
The ARM ID of the MSI used for SAP monitoring.
name string
The name of the resource
provisioningState string
State of provisioning of the SAP monitor.
storageAccountArmId string
The ARM ID of the Storage account used for SAP monitoring.
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"
appLocation string
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
identity UserAssignedServiceIdentityResponse
[currently not in use] Managed service identity(user assigned identities)
logAnalyticsWorkspaceArmId string
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration ManagedRGConfigurationResponse
Managed resource group configuration
monitorSubnet string
The subnet which the SAP monitor will be deployed in
routingPreference string
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
tags {[key: string]: string}
Resource tags.
zoneRedundancyPreference string
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.
errors MonitorPropertiesResponseErrors
Defines the SAP monitor errors.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
msi_arm_id str
The ARM ID of the MSI used for SAP monitoring.
name str
The name of the resource
provisioning_state str
State of provisioning of the SAP monitor.
storage_account_arm_id str
The ARM ID of the Storage account used for SAP monitoring.
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"
app_location str
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
identity UserAssignedServiceIdentityResponse
[currently not in use] Managed service identity(user assigned identities)
log_analytics_workspace_arm_id str
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managed_resource_group_configuration ManagedRGConfigurationResponse
Managed resource group configuration
monitor_subnet str
The subnet which the SAP monitor will be deployed in
routing_preference str
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
tags Mapping[str, str]
Resource tags.
zone_redundancy_preference str
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.
errors Property Map
Defines the SAP monitor errors.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
msiArmId String
The ARM ID of the MSI used for SAP monitoring.
name String
The name of the resource
provisioningState String
State of provisioning of the SAP monitor.
storageAccountArmId String
The ARM ID of the Storage account used for SAP monitoring.
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"
appLocation String
The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
identity Property Map
[currently not in use] Managed service identity(user assigned identities)
logAnalyticsWorkspaceArmId String
The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration Property Map
Managed resource group configuration
monitorSubnet String
The subnet which the SAP monitor will be deployed in
routingPreference String
Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET.
tags Map<String>
Resource tags.
zoneRedundancyPreference String
Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.

Supporting Types

ErrorResponse

Code This property is required. string
Server-defined set of error codes.
Details This property is required. List<Pulumi.AzureNative.Workloads.Inputs.ErrorResponse>
Array of details about specific errors that led to this reported error.
InnerError This property is required. Pulumi.AzureNative.Workloads.Inputs.ErrorResponseInnerError
Object containing more specific information than the current object about the error.
Message This property is required. string
Human-readable representation of the error.
Target This property is required. string
Target of the error.
Code This property is required. string
Server-defined set of error codes.
Details This property is required. []ErrorResponse
Array of details about specific errors that led to this reported error.
InnerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
Message This property is required. string
Human-readable representation of the error.
Target This property is required. string
Target of the error.
code This property is required. String
Server-defined set of error codes.
details This property is required. List<ErrorResponse>
Array of details about specific errors that led to this reported error.
innerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. String
Human-readable representation of the error.
target This property is required. String
Target of the error.
code This property is required. string
Server-defined set of error codes.
details This property is required. ErrorResponse[]
Array of details about specific errors that led to this reported error.
innerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. string
Human-readable representation of the error.
target This property is required. string
Target of the error.
code This property is required. str
Server-defined set of error codes.
details This property is required. Sequence[ErrorResponse]
Array of details about specific errors that led to this reported error.
inner_error This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. str
Human-readable representation of the error.
target This property is required. str
Target of the error.
code This property is required. String
Server-defined set of error codes.
details This property is required. List<Property Map>
Array of details about specific errors that led to this reported error.
innerError This property is required. Property Map
Object containing more specific information than the current object about the error.
message This property is required. String
Human-readable representation of the error.
target This property is required. String
Target of the error.

ErrorResponseInnerError

InnerError ErrorResponse
Standard error object.
innerError ErrorResponse
Standard error object.
innerError ErrorResponse
Standard error object.
inner_error ErrorResponse
Standard error object.
innerError Property Map
Standard error object.

ManagedRGConfigurationResponse

Name string
Managed resource group name
Name string
Managed resource group name
name String
Managed resource group name
name string
Managed resource group name
name str
Managed resource group name
name String
Managed resource group name

MonitorPropertiesResponseErrors

Code This property is required. string
Server-defined set of error codes.
Details This property is required. List<Pulumi.AzureNative.Workloads.Inputs.ErrorResponse>
Array of details about specific errors that led to this reported error.
InnerError This property is required. Pulumi.AzureNative.Workloads.Inputs.ErrorResponseInnerError
Object containing more specific information than the current object about the error.
Message This property is required. string
Human-readable representation of the error.
Target This property is required. string
Target of the error.
Code This property is required. string
Server-defined set of error codes.
Details This property is required. []ErrorResponse
Array of details about specific errors that led to this reported error.
InnerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
Message This property is required. string
Human-readable representation of the error.
Target This property is required. string
Target of the error.
code This property is required. String
Server-defined set of error codes.
details This property is required. List<ErrorResponse>
Array of details about specific errors that led to this reported error.
innerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. String
Human-readable representation of the error.
target This property is required. String
Target of the error.
code This property is required. string
Server-defined set of error codes.
details This property is required. ErrorResponse[]
Array of details about specific errors that led to this reported error.
innerError This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. string
Human-readable representation of the error.
target This property is required. string
Target of the error.
code This property is required. str
Server-defined set of error codes.
details This property is required. Sequence[ErrorResponse]
Array of details about specific errors that led to this reported error.
inner_error This property is required. ErrorResponseInnerError
Object containing more specific information than the current object about the error.
message This property is required. str
Human-readable representation of the error.
target This property is required. str
Target of the error.
code This property is required. String
Server-defined set of error codes.
details This property is required. List<Property Map>
Array of details about specific errors that led to this reported error.
innerError This property is required. Property Map
Object containing more specific information than the current object about the error.
message This property is required. String
Human-readable representation of the error.
target This property is required. String
Target of the error.

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.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

UserAssignedServiceIdentityResponse

Type This property is required. string
Type of manage identity
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Workloads.Inputs.UserAssignedIdentityResponse>
User assigned identities dictionary
Type This property is required. string
Type of manage identity
UserAssignedIdentities map[string]UserAssignedIdentityResponse
User assigned identities dictionary
type This property is required. String
Type of manage identity
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
User assigned identities dictionary
type This property is required. string
Type of manage identity
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
User assigned identities dictionary
type This property is required. str
Type of manage identity
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
User assigned identities dictionary
type This property is required. String
Type of manage identity
userAssignedIdentities Map<Property Map>
User assigned identities dictionary

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