Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. elastic
  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
pulumi/pulumi-azure-native

azure-native-v2.elastic.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
pulumi/pulumi-azure-native

Monitor resource. Azure REST API version: 2023-06-01.

Other available API versions: 2023-06-15-preview, 2023-07-01-preview, 2023-10-01-preview, 2023-11-01-preview, 2024-01-01-preview, 2024-03-01, 2024-05-01-preview, 2024-06-15-preview, 2024-10-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:elastic:getMonitor
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the Elastic resource belongs.
MonitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the Elastic resource belongs.
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the Elastic resource belongs.
monitorName
This property is required.
Changes to this property will trigger replacement.
string
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to which the Elastic resource belongs.
monitor_name
This property is required.
Changes to this property will trigger replacement.
str
Monitor resource name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group to which the Elastic resource belongs.
monitorName
This property is required.
Changes to this property will trigger replacement.
String
Monitor resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to which the Elastic resource belongs.

getMonitor Result

The following output properties are available:

Id string
ARM id of the monitor resource.
Location string
The location of the monitor resource
Name string
Name of the monitor resource.
Properties Pulumi.AzureNative.Elastic.Outputs.MonitorPropertiesResponse
Properties of the monitor resource.
SystemData Pulumi.AzureNative.Elastic.Outputs.SystemDataResponse
The system metadata relating to this resource
Type string
The type of the monitor resource.
Identity Pulumi.AzureNative.Elastic.Outputs.IdentityPropertiesResponse
Identity properties of the monitor resource.
Sku Pulumi.AzureNative.Elastic.Outputs.ResourceSkuResponse
SKU of the monitor resource.
Tags Dictionary<string, string>
The tags of the monitor resource.
Id string
ARM id of the monitor resource.
Location string
The location of the monitor resource
Name string
Name of the monitor resource.
Properties MonitorPropertiesResponse
Properties of the monitor resource.
SystemData SystemDataResponse
The system metadata relating to this resource
Type string
The type of the monitor resource.
Identity IdentityPropertiesResponse
Identity properties of the monitor resource.
Sku ResourceSkuResponse
SKU of the monitor resource.
Tags map[string]string
The tags of the monitor resource.
id String
ARM id of the monitor resource.
location String
The location of the monitor resource
name String
Name of the monitor resource.
properties MonitorPropertiesResponse
Properties of the monitor resource.
systemData SystemDataResponse
The system metadata relating to this resource
type String
The type of the monitor resource.
identity IdentityPropertiesResponse
Identity properties of the monitor resource.
sku ResourceSkuResponse
SKU of the monitor resource.
tags Map<String,String>
The tags of the monitor resource.
id string
ARM id of the monitor resource.
location string
The location of the monitor resource
name string
Name of the monitor resource.
properties MonitorPropertiesResponse
Properties of the monitor resource.
systemData SystemDataResponse
The system metadata relating to this resource
type string
The type of the monitor resource.
identity IdentityPropertiesResponse
Identity properties of the monitor resource.
sku ResourceSkuResponse
SKU of the monitor resource.
tags {[key: string]: string}
The tags of the monitor resource.
id str
ARM id of the monitor resource.
location str
The location of the monitor resource
name str
Name of the monitor resource.
properties MonitorPropertiesResponse
Properties of the monitor resource.
system_data SystemDataResponse
The system metadata relating to this resource
type str
The type of the monitor resource.
identity IdentityPropertiesResponse
Identity properties of the monitor resource.
sku ResourceSkuResponse
SKU of the monitor resource.
tags Mapping[str, str]
The tags of the monitor resource.
id String
ARM id of the monitor resource.
location String
The location of the monitor resource
name String
Name of the monitor resource.
properties Property Map
Properties of the monitor resource.
systemData Property Map
The system metadata relating to this resource
type String
The type of the monitor resource.
identity Property Map
Identity properties of the monitor resource.
sku Property Map
SKU of the monitor resource.
tags Map<String>
The tags of the monitor resource.

Supporting Types

ElasticCloudDeploymentResponse

AzureSubscriptionId This property is required. string
Associated Azure subscription Id for the elastic deployment.
DeploymentId This property is required. string
Elastic deployment Id
ElasticsearchRegion This property is required. string
Region where Deployment at Elastic side took place.
ElasticsearchServiceUrl This property is required. string
Elasticsearch ingestion endpoint of the Elastic deployment.
KibanaServiceUrl This property is required. string
Kibana endpoint of the Elastic deployment.
KibanaSsoUrl This property is required. string
Kibana dashboard sso URL of the Elastic deployment.
Name This property is required. string
Elastic deployment name
AzureSubscriptionId This property is required. string
Associated Azure subscription Id for the elastic deployment.
DeploymentId This property is required. string
Elastic deployment Id
ElasticsearchRegion This property is required. string
Region where Deployment at Elastic side took place.
ElasticsearchServiceUrl This property is required. string
Elasticsearch ingestion endpoint of the Elastic deployment.
KibanaServiceUrl This property is required. string
Kibana endpoint of the Elastic deployment.
KibanaSsoUrl This property is required. string
Kibana dashboard sso URL of the Elastic deployment.
Name This property is required. string
Elastic deployment name
azureSubscriptionId This property is required. String
Associated Azure subscription Id for the elastic deployment.
deploymentId This property is required. String
Elastic deployment Id
elasticsearchRegion This property is required. String
Region where Deployment at Elastic side took place.
elasticsearchServiceUrl This property is required. String
Elasticsearch ingestion endpoint of the Elastic deployment.
kibanaServiceUrl This property is required. String
Kibana endpoint of the Elastic deployment.
kibanaSsoUrl This property is required. String
Kibana dashboard sso URL of the Elastic deployment.
name This property is required. String
Elastic deployment name
azureSubscriptionId This property is required. string
Associated Azure subscription Id for the elastic deployment.
deploymentId This property is required. string
Elastic deployment Id
elasticsearchRegion This property is required. string
Region where Deployment at Elastic side took place.
elasticsearchServiceUrl This property is required. string
Elasticsearch ingestion endpoint of the Elastic deployment.
kibanaServiceUrl This property is required. string
Kibana endpoint of the Elastic deployment.
kibanaSsoUrl This property is required. string
Kibana dashboard sso URL of the Elastic deployment.
name This property is required. string
Elastic deployment name
azure_subscription_id This property is required. str
Associated Azure subscription Id for the elastic deployment.
deployment_id This property is required. str
Elastic deployment Id
elasticsearch_region This property is required. str
Region where Deployment at Elastic side took place.
elasticsearch_service_url This property is required. str
Elasticsearch ingestion endpoint of the Elastic deployment.
kibana_service_url This property is required. str
Kibana endpoint of the Elastic deployment.
kibana_sso_url This property is required. str
Kibana dashboard sso URL of the Elastic deployment.
name This property is required. str
Elastic deployment name
azureSubscriptionId This property is required. String
Associated Azure subscription Id for the elastic deployment.
deploymentId This property is required. String
Elastic deployment Id
elasticsearchRegion This property is required. String
Region where Deployment at Elastic side took place.
elasticsearchServiceUrl This property is required. String
Elasticsearch ingestion endpoint of the Elastic deployment.
kibanaServiceUrl This property is required. String
Kibana endpoint of the Elastic deployment.
kibanaSsoUrl This property is required. String
Kibana dashboard sso URL of the Elastic deployment.
name This property is required. String
Elastic deployment name

ElasticCloudUserResponse

ElasticCloudSsoDefaultUrl This property is required. string
Elastic cloud default dashboard sso URL of the Elastic user account.
EmailAddress This property is required. string
Email of the Elastic User Account.
Id This property is required. string
User Id of the elastic account of the User.
ElasticCloudSsoDefaultUrl This property is required. string
Elastic cloud default dashboard sso URL of the Elastic user account.
EmailAddress This property is required. string
Email of the Elastic User Account.
Id This property is required. string
User Id of the elastic account of the User.
elasticCloudSsoDefaultUrl This property is required. String
Elastic cloud default dashboard sso URL of the Elastic user account.
emailAddress This property is required. String
Email of the Elastic User Account.
id This property is required. String
User Id of the elastic account of the User.
elasticCloudSsoDefaultUrl This property is required. string
Elastic cloud default dashboard sso URL of the Elastic user account.
emailAddress This property is required. string
Email of the Elastic User Account.
id This property is required. string
User Id of the elastic account of the User.
elastic_cloud_sso_default_url This property is required. str
Elastic cloud default dashboard sso URL of the Elastic user account.
email_address This property is required. str
Email of the Elastic User Account.
id This property is required. str
User Id of the elastic account of the User.
elasticCloudSsoDefaultUrl This property is required. String
Elastic cloud default dashboard sso URL of the Elastic user account.
emailAddress This property is required. String
Email of the Elastic User Account.
id This property is required. String
User Id of the elastic account of the User.

ElasticPropertiesResponse

ElasticCloudDeployment ElasticCloudDeploymentResponse
Details of the elastic cloud deployment.
ElasticCloudUser ElasticCloudUserResponse
Details of the user's elastic account.
elasticCloudDeployment ElasticCloudDeploymentResponse
Details of the elastic cloud deployment.
elasticCloudUser ElasticCloudUserResponse
Details of the user's elastic account.
elasticCloudDeployment ElasticCloudDeploymentResponse
Details of the elastic cloud deployment.
elasticCloudUser ElasticCloudUserResponse
Details of the user's elastic account.
elastic_cloud_deployment ElasticCloudDeploymentResponse
Details of the elastic cloud deployment.
elastic_cloud_user ElasticCloudUserResponse
Details of the user's elastic account.
elasticCloudDeployment Property Map
Details of the elastic cloud deployment.
elasticCloudUser Property Map
Details of the user's elastic account.

IdentityPropertiesResponse

PrincipalId This property is required. string
The identity ID.
TenantId This property is required. string
The tenant ID of resource.
Type string
Managed identity type.
PrincipalId This property is required. string
The identity ID.
TenantId This property is required. string
The tenant ID of resource.
Type string
Managed identity type.
principalId This property is required. String
The identity ID.
tenantId This property is required. String
The tenant ID of resource.
type String
Managed identity type.
principalId This property is required. string
The identity ID.
tenantId This property is required. string
The tenant ID of resource.
type string
Managed identity type.
principal_id This property is required. str
The identity ID.
tenant_id This property is required. str
The tenant ID of resource.
type str
Managed identity type.
principalId This property is required. String
The identity ID.
tenantId This property is required. String
The tenant ID of resource.
type String
Managed identity type.

MonitorPropertiesResponse

LiftrResourceCategory This property is required. string
LiftrResourcePreference This property is required. int
The priority of the resource.
ElasticProperties Pulumi.AzureNative.Elastic.Inputs.ElasticPropertiesResponse
Elastic cloud properties.
GenerateApiKey bool
Flag to determine if User API Key has to be generated and shared.
MonitoringStatus string
Flag specifying if the resource monitoring is enabled or disabled.
ProvisioningState string
Provisioning state of the monitor resource.
Version string
Version of elastic of the monitor resource
LiftrResourceCategory This property is required. string
LiftrResourcePreference This property is required. int
The priority of the resource.
ElasticProperties ElasticPropertiesResponse
Elastic cloud properties.
GenerateApiKey bool
Flag to determine if User API Key has to be generated and shared.
MonitoringStatus string
Flag specifying if the resource monitoring is enabled or disabled.
ProvisioningState string
Provisioning state of the monitor resource.
Version string
Version of elastic of the monitor resource
liftrResourceCategory This property is required. String
liftrResourcePreference This property is required. Integer
The priority of the resource.
elasticProperties ElasticPropertiesResponse
Elastic cloud properties.
generateApiKey Boolean
Flag to determine if User API Key has to be generated and shared.
monitoringStatus String
Flag specifying if the resource monitoring is enabled or disabled.
provisioningState String
Provisioning state of the monitor resource.
version String
Version of elastic of the monitor resource
liftrResourceCategory This property is required. string
liftrResourcePreference This property is required. number
The priority of the resource.
elasticProperties ElasticPropertiesResponse
Elastic cloud properties.
generateApiKey boolean
Flag to determine if User API Key has to be generated and shared.
monitoringStatus string
Flag specifying if the resource monitoring is enabled or disabled.
provisioningState string
Provisioning state of the monitor resource.
version string
Version of elastic of the monitor resource
liftr_resource_category This property is required. str
liftr_resource_preference This property is required. int
The priority of the resource.
elastic_properties ElasticPropertiesResponse
Elastic cloud properties.
generate_api_key bool
Flag to determine if User API Key has to be generated and shared.
monitoring_status str
Flag specifying if the resource monitoring is enabled or disabled.
provisioning_state str
Provisioning state of the monitor resource.
version str
Version of elastic of the monitor resource
liftrResourceCategory This property is required. String
liftrResourcePreference This property is required. Number
The priority of the resource.
elasticProperties Property Map
Elastic cloud properties.
generateApiKey Boolean
Flag to determine if User API Key has to be generated and shared.
monitoringStatus String
Flag specifying if the resource monitoring is enabled or disabled.
provisioningState String
Provisioning state of the monitor resource.
version String
Version of elastic of the monitor resource

ResourceSkuResponse

Name This property is required. string
Name of the SKU.
Name This property is required. string
Name of the SKU.
name This property is required. String
Name of the SKU.
name This property is required. string
Name of the SKU.
name This property is required. str
Name of the SKU.
name This property is required. String
Name of the SKU.

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