Monitors - Get

Service:

Dynatrace

API Version:

2021-09-01

Get a MonitorResource

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}?api-version=2021-09-01

URI Parameters

Name	In	Required	Type	Description
monitorName	path	True	string	Monitor resource name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	MonitorResource	ARM operation completed successfully.
Other Status Codes	ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Monitors_Get_MaximumSet_Gen

Monitors_Get_MinimumSet_Gen

Monitors_Get_MaximumSet_Gen

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor?api-version=2021-09-01

Java

import com.azure.core.util.Context;

/** Samples for Monitors GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: Monitors_Get_MaximumSet_Gen.
     *
     * @param manager Entry point to DynatraceManager.
     */
    public static void monitorsGetMaximumSetGen(com.azure.resourcemanager.dynatrace.DynatraceManager manager) {
        manager.monitors().getByResourceGroupWithResponse("myResourceGroup", "myMonitor", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dynatrace import DynatraceObservabilityMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dynatrace
# USAGE
    python monitors_get_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DynatraceObservabilityMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.monitors.get(
        resource_group_name="myResourceGroup",
        monitor_name="myMonitor",
    )
    print(response)


# x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdynatrace_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dynatrace/armdynatrace"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3751f321654db00858e70649291af5c81e94611e/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MaximumSet_Gen.json
func ExampleMonitorsClient_Get_monitorsGetMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdynatrace.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMonitorsClient().Get(ctx, "myResourceGroup", "myMonitor", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MonitorResource = armdynatrace.MonitorResource{
	// 	Name: to.Ptr("myMonitor"),
	// 	Type: to.Ptr("Dynatrace.Observability/monitors"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"Environment": to.Ptr("Dev"),
	// 	},
	// 	Identity: &armdynatrace.IdentityProperties{
	// 		Type: to.Ptr(armdynatrace.ManagedIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("4534676867978"),
	// 		TenantID: to.Ptr("23456789001"),
	// 	},
	// 	Properties: &armdynatrace.MonitorProperties{
	// 		DynatraceEnvironmentProperties: &armdynatrace.EnvironmentProperties{
	// 			AccountInfo: &armdynatrace.AccountInfo{
	// 				AccountID: to.Ptr("1234567890"),
	// 				RegionID: to.Ptr("wus2"),
	// 			},
	// 			EnvironmentInfo: &armdynatrace.EnvironmentInfo{
	// 				EnvironmentID: to.Ptr("a23xcv456"),
	// 				IngestionKey: to.Ptr("1234567890"),
	// 				LandingURL: to.Ptr("https://a23xcv456.dynatrace.com"),
	// 				LogsIngestionEndpoint: to.Ptr("https://dynatrace.com"),
	// 			},
	// 			SingleSignOnProperties: &armdynatrace.SingleSignOnProperties{
	// 				AADDomains: []*string{
	// 					to.Ptr("mpliftrdt20210811outlook.onmicrosoft.com")},
	// 					EnterpriseAppID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					SingleSignOnState: to.Ptr(armdynatrace.SingleSignOnStatesEnable),
	// 					SingleSignOnURL: to.Ptr("https://www.dynatrace.io/IAmSomeHash"),
	// 				},
	// 				UserID: to.Ptr("alice123"),
	// 			},
	// 			LiftrResourceCategory: to.Ptr(armdynatrace.LiftrResourceCategoriesUnknown),
	// 			LiftrResourcePreference: to.Ptr[int32](28),
	// 			MarketplaceSubscriptionStatus: to.Ptr(armdynatrace.MarketplaceSubscriptionStatusActive),
	// 			MonitoringStatus: to.Ptr(armdynatrace.MonitoringStatusEnabled),
	// 			PlanData: &armdynatrace.PlanData{
	// 				BillingCycle: to.Ptr("Monthly"),
	// 				EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-30T15:14:33+02:00"); return t}()),
	// 				PlanDetails: to.Ptr("dynatraceapitestplan"),
	// 				UsageType: to.Ptr("Committed"),
	// 			},
	// 			ProvisioningState: to.Ptr(armdynatrace.ProvisioningStateSucceeded),
	// 			UserInfo: &armdynatrace.UserInfo{
	// 				Country: to.Ptr("westus2"),
	// 				EmailAddress: to.Ptr("alice@microsoft.com"),
	// 				FirstName: to.Ptr("Alice"),
	// 				LastName: to.Ptr("Bobab"),
	// 				PhoneNumber: to.Ptr("123456"),
	// 			},
	// 		},
	// 		SystemData: &armdynatrace.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-16T04:25:21.040Z"); return t}()),
	// 			CreatedBy: to.Ptr("alice@microsoft.com"),
	// 			CreatedByType: to.Ptr(armdynatrace.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-16T04:25:21.040Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("alice@microsoft.com"),
	// 			LastModifiedByType: to.Ptr(armdynatrace.CreatedByTypeUser),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DynatraceObservability } = require("@azure/arm-dynatrace");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a MonitorResource
 *
 * @summary Get a MonitorResource
 * x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MaximumSet_Gen.json
 */
async function monitorsGetMaximumSetGen() {
  const subscriptionId =
    process.env["DYNATRACE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["DYNATRACE_RESOURCE_GROUP"] || "myResourceGroup";
  const monitorName = "myMonitor";
  const credential = new DefaultAzureCredential();
  const client = new DynatraceObservability(credential, subscriptionId);
  const result = await client.monitors.get(resourceGroupName, monitorName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "identity": {
    "principalId": "4534676867978",
    "tenantId": "23456789001",
    "type": "SystemAssigned"
  },
  "properties": {
    "monitoringStatus": "Enabled",
    "marketplaceSubscriptionStatus": "Active",
    "dynatraceEnvironmentProperties": {
      "userId": "alice123",
      "accountInfo": {
        "accountId": "1234567890",
        "regionId": "wus2"
      },
      "environmentInfo": {
        "environmentId": "a23xcv456",
        "ingestionKey": "1234567890",
        "logsIngestionEndpoint": "https://dynatrace.com",
        "landingURL": "https://a23xcv456.dynatrace.com"
      },
      "singleSignOnProperties": {
        "singleSignOnState": "Enable",
        "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
        "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash",
        "aadDomains": [
          "mpliftrdt20210811outlook.onmicrosoft.com"
        ]
      }
    },
    "userInfo": {
      "firstName": "Alice",
      "lastName": "Bobab",
      "emailAddress": "alice@microsoft.com",
      "phoneNumber": "123456",
      "country": "westus2"
    },
    "planData": {
      "usageType": "Committed",
      "billingCycle": "Monthly",
      "planDetails": "dynatraceapitestplan",
      "effectiveDate": "2019-08-30T15:14:33+02:00"
    },
    "liftrResourceCategory": "Unknown",
    "liftrResourcePreference": 28,
    "provisioningState": "Accepted"
  },
  "systemData": {
    "createdBy": "alice@microsoft.com",
    "createdByType": "User",
    "createdAt": "2021-07-16T04:25:21.040Z",
    "lastModifiedBy": "alice@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-07-16T04:25:21.040Z"
  },
  "tags": {
    "Environment": "Dev"
  },
  "location": "West US 2",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
  "name": "myMonitor",
  "type": "Dynatrace.Observability/monitors"
}

Monitors_Get_MinimumSet_Gen

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor?api-version=2021-09-01

Java

import com.azure.core.util.Context;

/** Samples for Monitors GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MinimumSet_Gen.json
     */
    /**
     * Sample code: Monitors_Get_MinimumSet_Gen.
     *
     * @param manager Entry point to DynatraceManager.
     */
    public static void monitorsGetMinimumSetGen(com.azure.resourcemanager.dynatrace.DynatraceManager manager) {
        manager.monitors().getByResourceGroupWithResponse("myResourceGroup", "myMonitor", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.dynatrace import DynatraceObservabilityMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dynatrace
# USAGE
    python monitors_get_minimum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DynatraceObservabilityMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.monitors.get(
        resource_group_name="myResourceGroup",
        monitor_name="myMonitor",
    )
    print(response)


# x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MinimumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdynatrace_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dynatrace/armdynatrace"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3751f321654db00858e70649291af5c81e94611e/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MinimumSet_Gen.json
func ExampleMonitorsClient_Get_monitorsGetMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdynatrace.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMonitorsClient().Get(ctx, "myResourceGroup", "myMonitor", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MonitorResource = armdynatrace.MonitorResource{
	// 	Location: to.Ptr("West US 2"),
	// 	Properties: &armdynatrace.MonitorProperties{
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DynatraceObservability } = require("@azure/arm-dynatrace");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a MonitorResource
 *
 * @summary Get a MonitorResource
 * x-ms-original-file: specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2021-09-01/examples/Monitors_Get_MinimumSet_Gen.json
 */
async function monitorsGetMinimumSetGen() {
  const subscriptionId =
    process.env["DYNATRACE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["DYNATRACE_RESOURCE_GROUP"] || "myResourceGroup";
  const monitorName = "myMonitor";
  const credential = new DefaultAzureCredential();
  const client = new DynatraceObservability(credential, subscriptionId);
  const result = await client.monitors.get(resourceGroupName, monitorName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {},
  "location": "West US 2"
}

Definitions

Name	Description
AccountInfo	Dynatrace Account Information
createdByType	The type of identity that created the resource.
DynatraceEnvironmentProperties	Properties of the Dynatrace environment.
DynatraceSingleSignOnProperties	The details of a Dynatrace single sign-on.
EnvironmentInfo	Dynatrace Environment Information
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityProperties	The properties of the managed service identities assigned to this resource.
LiftrResourceCategories	Liftr resource category
ManagedIdentityType	The kind of managed identity assigned to this resource.
MarketplaceSubscriptionStatus	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.
MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
MonitorResource	Dynatrace Monitor Resource
PlanData	Billing plan information.
ProvisioningState	Provisioning state of the monitoring resource
SingleSignOnStates	Various states of the SSO resource
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	A managed identity assigned by the user.
UserInfo	User info.

AccountInfo

Object

Dynatrace Account Information

Name	Type	Description
accountId	string	Account Id of the account this environment is linked to
regionId	string	Region in which the account is created

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DynatraceEnvironmentProperties

Object

Properties of the Dynatrace environment.

Name	Type	Description
accountInfo	AccountInfo	Dynatrace Account Information
environmentInfo	EnvironmentInfo	Dynatrace Environment Information
singleSignOnProperties	DynatraceSingleSignOnProperties	The details of a Dynatrace single sign-on.
userId	string	User id

DynatraceSingleSignOnProperties

Object

The details of a Dynatrace single sign-on.

Name	Type	Description
aadDomains	string[]	array of Aad(azure active directory) domains
enterpriseAppId	string	Version of the Dynatrace agent installed on the VM.
provisioningState	ProvisioningState	Provisioning state of the resource.
singleSignOnState	SingleSignOnStates	State of Single Sign On
singleSignOnUrl	string	The login URL specific to this Dynatrace Environment

EnvironmentInfo

Object

Dynatrace Environment Information

Name	Type	Description
environmentId	string	Id of the environment created
ingestionKey	string	Ingestion key of the environment
landingURL	string	Landing URL for Dynatrace environment
logsIngestionEndpoint	string	Ingestion endpoint used for sending logs

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityProperties

Object

The properties of the managed service identities assigned to this resource.

Name	Type	Description
principalId	string	The active directory identifier of this principal.
tenantId	string	The Active Directory tenant id of the principal.
type	ManagedIdentityType	The type of managed identity assigned to this resource.
userAssignedIdentities	<string,  UserAssignedIdentity>	The identities assigned to this resource by the user.

LiftrResourceCategories

Enumeration

Liftr resource category

Value	Description
Unknown
MonitorLogs

ManagedIdentityType

Enumeration

The kind of managed identity assigned to this resource.

Value	Description
SystemAssigned
UserAssigned
SystemAndUserAssigned

MarketplaceSubscriptionStatus

Enumeration

Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.

Value	Description
Active
Suspended

MonitoringStatus

Enumeration

Flag specifying if the resource monitoring is enabled or disabled.

Value	Description
Enabled
Disabled

MonitorResource

Object

Dynatrace Monitor Resource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	IdentityProperties	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.dynatraceEnvironmentProperties	DynatraceEnvironmentProperties	Properties of the Dynatrace environment.
properties.liftrResourceCategory	LiftrResourceCategories	Liftr Resource category.
properties.liftrResourcePreference	integer (int32)	The priority of the resource.
properties.marketplaceSubscriptionStatus	MarketplaceSubscriptionStatus	Marketplace subscription status.
properties.monitoringStatus	MonitoringStatus	Status of the monitor.
properties.planData	PlanData	Billing plan information.
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
properties.userInfo	UserInfo	User info.
systemData	systemData	System metadata for this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PlanData

Object

Billing plan information.

Name	Type	Description
billingCycle	string	different billing cycles like MONTHLY/WEEKLY. this could be enum
effectiveDate	string (date-time)	date when plan was applied
planDetails	string	plan id as published by Dynatrace
usageType	string	different usage type like PAYG/COMMITTED. this could be enum

ProvisioningState

Enumeration

Provisioning state of the monitoring resource

Value	Description
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

SingleSignOnStates

Enumeration

Various states of the SSO resource

Value	Description
Initial
Enable
Disable
Existing

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

A managed identity assigned by the user.

Name	Type	Description
clientId	string	The active directory client identifier for this principal.
principalId	string	The active directory identifier for this principal.

UserInfo

Object

User info.

Name	Type	Description
country	string	Country of the user
emailAddress	string pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$	Email of the user used by Dynatrace for contacting them if needed
firstName	string	First Name of the user
lastName	string	Last Name of the user
phoneNumber	string maxLength: 40	Phone number of the user used by Dynatrace for contacting them if needed