Package-level declarations

Types

Link copied to clipboard
data class AccessModeSettingsExclusionResponse(val ingestionAccessMode: String? = null, val privateEndpointConnectionName: String? = null, val queryAccessMode: String? = null)

Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.

Link copied to clipboard
data class AccessModeSettingsResponse(val exclusions: List<AccessModeSettingsExclusionResponse>? = null, val ingestionAccessMode: String, val queryAccessMode: String)

Properties that define the scope private link mode settings.

Link copied to clipboard
data class ActionsResponse(val actionGroups: List<String>? = null, val actionProperties: Map<String, String>? = null, val customProperties: Map<String, String>? = null)

Actions to invoke when the alert fires.

Link copied to clipboard
data class ArmRoleReceiverResponse(val name: String, val roleId: String, val useCommonAlertSchema: Boolean? = null)

An arm role receiver.

Link copied to clipboard
data class AutomationRunbookReceiverResponse(val automationAccountId: String, val isGlobalRunbook: Boolean, val managedIdentity: String? = null, val name: String? = null, val runbookName: String, val serviceUri: String? = null, val useCommonAlertSchema: Boolean? = null, val webhookResourceId: String)

The Azure Automation Runbook notification receiver.

Link copied to clipboard
data class AutoscaleNotificationResponse(val email: EmailNotificationResponse? = null, val operation: String, val webhooks: List<WebhookNotificationResponse>? = null)

Autoscale notification.

Link copied to clipboard
data class AutoscaleProfileResponse(val capacity: ScaleCapacityResponse, val fixedDate: TimeWindowResponse? = null, val name: String, val recurrence: RecurrenceResponse? = null, val rules: List<ScaleRuleResponse>)

Autoscale profile.

Link copied to clipboard
data class AutoscaleSettingResponse(val enabled: Boolean? = null, val name: String? = null, val notifications: List<AutoscaleNotificationResponse>? = null, val predictiveAutoscalePolicy: PredictiveAutoscalePolicyResponse? = null, val profiles: List<AutoscaleProfileResponse>, val targetResourceLocation: String? = null, val targetResourceUri: String? = null)

A setting that contains all of the configuration for the automatic scaling of a resource.

Link copied to clipboard
data class AzureAppPushReceiverResponse(val emailAddress: String, val name: String)

The Azure mobile App push notification receiver.

Link copied to clipboard
data class AzureFunctionReceiverResponse(val functionAppResourceId: String, val functionName: String, val httpTriggerUrl: String, val managedIdentity: String? = null, val name: String, val useCommonAlertSchema: Boolean? = null)

An azure function receiver.

data class AzureMonitorWorkspaceLogsApiConfigResponse(val dataCollectionEndpointUrl: String, val dataCollectionRule: String, val schema: SchemaMapResponse, val stream: String)

Azure Monitor Workspace Logs Api configurations.

Azure Monitor Workspace Logs specific configurations.

The complex type of the extended location.

Link copied to clipboard
data class BatchProcessorResponse(val batchSize: Int? = null, val timeout: Int? = null)

Batch processor.

Link copied to clipboard
data class CacheConfigurationResponse(val maxStorageUsage: Int? = null, val retentionPeriod: Int? = null)

Cache configurations.

Link copied to clipboard
data class ConcurrencyConfigurationResponse(val batchQueueSize: Int? = null, val workerCount: Int? = null)

Concurrent publishing configuration.

Link copied to clipboard
data class ConditionResponse(val alertSensitivity: String? = null, val criterionType: String? = null, val dimensions: List<DimensionResponse>? = null, val failingPeriods: ConditionResponseFailingPeriods? = null, val ignoreDataBefore: String? = null, val metricMeasureColumn: String? = null, val metricName: String? = null, val operator: String? = null, val query: String? = null, val resourceIdColumn: String? = null, val threshold: Double? = null, val timeAggregation: String? = null)

A condition of the scheduled query rule.

Link copied to clipboard
data class ConditionResponseFailingPeriods(val minFailingPeriodsToAlert: Double? = null, val numberOfEvaluationPeriods: Double? = null)

The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.

data class DiagnosticSettingsCategoryResourceResponse(val categoryGroups: List<String>? = null, val categoryType: String? = null, val id: String, val name: String, val systemData: SystemDataResponse, val type: String)

The diagnostic settings category resource.

Link copied to clipboard
data class DimensionResponse(val name: String, val operator: String, val values: List<String>)

Dimension splitting and filtering definition

Link copied to clipboard
data class EmailNotificationResponse(val customEmails: List<String>? = null, val sendToSubscriptionAdministrator: Boolean? = null, val sendToSubscriptionCoAdministrators: Boolean? = null)

Email notification of an autoscale event.

Link copied to clipboard
data class EmailReceiverResponse(val emailAddress: String, val name: String, val status: String, val useCommonAlertSchema: Boolean? = null)

An email receiver.

Link copied to clipboard
data class EventHubReceiverResponse(val eventHubName: String, val eventHubNameSpace: String, val managedIdentity: String? = null, val name: String, val subscriptionId: String, val tenantId: String? = null, val useCommonAlertSchema: Boolean? = null)

An Event hub receiver.

Link copied to clipboard
data class ExporterResponse(val azureMonitorWorkspaceLogs: AzureMonitorWorkspaceLogsExporterResponse? = null, val name: String, val tcp: TcpExporterResponse? = null, val type: String)

Exporter Info.

Link copied to clipboard
data class GetActionGroupResult(val armRoleReceivers: List<ArmRoleReceiverResponse>? = null, val automationRunbookReceivers: List<AutomationRunbookReceiverResponse>? = null, val azureApiVersion: String, val azureAppPushReceivers: List<AzureAppPushReceiverResponse>? = null, val azureFunctionReceivers: List<AzureFunctionReceiverResponse>? = null, val emailReceivers: List<EmailReceiverResponse>? = null, val enabled: Boolean, val eventHubReceivers: List<EventHubReceiverResponse>? = null, val groupShortName: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val incidentReceivers: List<IncidentReceiverResponse>? = null, val itsmReceivers: List<ItsmReceiverResponse>? = null, val location: String, val logicAppReceivers: List<LogicAppReceiverResponse>? = null, val name: String, val smsReceivers: List<SmsReceiverResponse>? = null, val tags: Map<String, String>? = null, val type: String, val voiceReceivers: List<VoiceReceiverResponse>? = null, val webhookReceivers: List<WebhookReceiverResponse>? = null)

An action group resource.

Link copied to clipboard
data class GetAutoscaleSettingResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: AutoscaleSettingResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The autoscale setting resource.

Link copied to clipboard
data class GetAzureMonitorWorkspaceResult(val accountId: String, val azureApiVersion: String, val defaultIngestionSettings: IngestionSettingsResponse, val etag: String, val id: String, val location: String, val metrics: MetricsResponse? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

An Azure Monitor Workspace definition.

Link copied to clipboard
data class GetDiagnosticSettingResult(val azureApiVersion: String, val eventHubAuthorizationRuleId: String? = null, val eventHubName: String? = null, val id: String, val logAnalyticsDestinationType: String? = null, val logs: List<LogSettingsResponse>? = null, val marketplacePartnerId: String? = null, val metrics: List<MetricSettingsResponse>? = null, val name: String, val serviceBusRuleId: String? = null, val storageAccountId: String? = null, val systemData: SystemDataResponse, val type: String, val workspaceId: String? = null)

The diagnostic setting resource.

data class GetManagementGroupDiagnosticSettingResult(val azureApiVersion: String, val eventHubAuthorizationRuleId: String? = null, val eventHubName: String? = null, val id: String, val logs: List<ManagementGroupLogSettingsResponse>? = null, val marketplacePartnerId: String? = null, val name: String, val serviceBusRuleId: String? = null, val storageAccountId: String? = null, val systemData: SystemDataResponse, val type: String, val workspaceId: String? = null)

The management group diagnostic setting resource.

Link copied to clipboard
data class GetPipelineGroupResult(val azureApiVersion: String, val extendedLocation: AzureResourceManagerCommonTypesExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val properties: PipelineGroupPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A pipeline group definition.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class GetPrivateLinkScopedResourceResult(val azureApiVersion: String, val id: String, val kind: String? = null, val linkedResourceId: String? = null, val name: String, val provisioningState: String, val subscriptionLocation: String? = null, val systemData: SystemDataResponse, val type: String)

A private link scoped resource

Link copied to clipboard
data class GetPrivateLinkScopeResult(val accessModeSettings: AccessModeSettingsResponse, val azureApiVersion: String, val id: String, val location: String, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

An Azure Monitor PrivateLinkScope definition.

Link copied to clipboard
data class GetScheduledQueryRuleResult(val actions: ActionsResponse? = null, val autoMitigate: Boolean? = null, val azureApiVersion: String, val checkWorkspaceAlertsStorageConfigured: Boolean? = null, val createdWithApiVersion: String, val criteria: ScheduledQueryRuleCriteriaResponse, val description: String? = null, val displayName: String? = null, val enabled: Boolean, val etag: String, val evaluationFrequency: String? = null, val id: String, val identity: IdentityResponse? = null, val isLegacyLogAnalyticsRule: Boolean, val isWorkspaceAlertsStorageConfigured: Boolean, val kind: String? = null, val location: String, val muteActionsDuration: String? = null, val name: String, val overrideQueryTimeRange: String? = null, val resolveConfiguration: RuleResolveConfigurationResponse? = null, val scopes: List<String>, val severity: Double? = null, val skipQueryValidation: Boolean? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetResourceTypes: List<String>? = null, val type: String, val windowSize: String? = null)

The scheduled query rule resource.

Link copied to clipboard
data class GetSubscriptionDiagnosticSettingResult(val azureApiVersion: String, val eventHubAuthorizationRuleId: String? = null, val eventHubName: String? = null, val id: String, val logs: List<SubscriptionLogSettingsResponse>? = null, val marketplacePartnerId: String? = null, val name: String, val serviceBusRuleId: String? = null, val storageAccountId: String? = null, val systemData: SystemDataResponse, val type: String, val workspaceId: String? = null)

The subscription diagnostic setting resource.

Link copied to clipboard
data class GetTenantActionGroupResult(val azureApiVersion: String, val azureAppPushReceivers: List<AzureAppPushReceiverResponse>? = null, val emailReceivers: List<EmailReceiverResponse>? = null, val enabled: Boolean, val groupShortName: String, val id: String, val location: String, val name: String, val smsReceivers: List<SmsReceiverResponse>? = null, val tags: Map<String, String>? = null, val type: String, val voiceReceivers: List<VoiceReceiverResponse>? = null, val webhookReceivers: List<WebhookReceiverResponse>? = null)

A tenant action group resource.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserIdentityPropertiesResponse>? = null)

Identity for the resource.

Link copied to clipboard
data class IncidentReceiverResponse(val connection: IncidentServiceConnectionResponse, val incidentManagementService: String, val mappings: Map<String, String>, val name: String)

An Incident receiver.

Link copied to clipboard
data class IncidentServiceConnectionResponse(val id: String, val name: String)

The connection info for Incident Receiver.

Link copied to clipboard
data class IngestionSettingsResponse(val dataCollectionEndpointResourceId: String, val dataCollectionRuleResourceId: String)

Settings for data ingestion

Link copied to clipboard
data class ItsmReceiverResponse(val connectionId: String, val name: String, val region: String, val ticketConfiguration: String, val workspaceId: String)

An Itsm receiver.

Link copied to clipboard
data class JsonArrayMapperResponse(val destinationField: JsonMapperDestinationFieldResponse? = null, val keys: List<String>, val sourceField: JsonMapperSourceFieldResponse? = null)

A component that allows parsing a value from sourceField as a json array, match a key to each parsed value from keys, and output the key-value map to destinationField field.

Link copied to clipboard
data class JsonMapperDestinationFieldResponse(val destination: String? = null, val fieldName: String? = null)

JsonArrayMapper destination field used to describe the field to which the parsed output will be written.

Link copied to clipboard
data class JsonMapperSourceFieldResponse(val fieldName: String? = null)

JsonArrayMapper source field used to describe the field from which the json array will be read.

Link copied to clipboard

Represents a collection of diagnostic setting category resources.

Link copied to clipboard
data class LogicAppReceiverResponse(val callbackUrl: String, val managedIdentity: String? = null, val name: String, val resourceId: String, val useCommonAlertSchema: Boolean? = null)

A logic app receiver.

Link copied to clipboard
data class LogSettingsResponse(val category: String? = null, val categoryGroup: String? = null, val enabled: Boolean, val retentionPolicy: RetentionPolicyResponse? = null)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class ManagementGroupLogSettingsResponse(val category: String? = null, val categoryGroup: String? = null, val enabled: Boolean)

Part of Management Group diagnostic setting. Specifies the settings for a particular log.

Link copied to clipboard
data class MetricSettingsResponse(val category: String? = null, val enabled: Boolean, val retentionPolicy: RetentionPolicyResponse? = null, val timeGrain: String? = null)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

Link copied to clipboard
data class MetricsResponse(val internalId: String, val prometheusQueryEndpoint: String)

Information about metrics for the workspace

Link copied to clipboard
data class MetricTriggerResponse(val dimensions: List<ScaleRuleMetricDimensionResponse>? = null, val dividePerInstance: Boolean? = null, val metricName: String, val metricNamespace: String? = null, val metricResourceLocation: String? = null, val metricResourceUri: String, val operator: String, val statistic: String, val threshold: Double, val timeAggregation: String, val timeGrain: String, val timeWindow: String)

The trigger that results in a scaling action.

Link copied to clipboard
data class NetworkingConfigurationResponse(val externalNetworkingMode: String, val host: String? = null, val routes: List<NetworkingRouteResponse>)

Networking configuration for the pipeline group instance.

Link copied to clipboard
data class NetworkingRouteResponse(val path: String? = null, val port: Int? = null, val receiver: String, val subdomain: String? = null)

Networking route configuration.

Link copied to clipboard
data class OtlpReceiverResponse(val endpoint: String)

OTLP Receiver.

Link copied to clipboard
data class PersistenceConfigurationsResponse(val persistentVolumeName: String)

Persistence options to all pipelines in the instance.

Link copied to clipboard
data class PipelineGroupPropertiesResponse(val exporters: List<ExporterResponse>, val networkingConfigurations: List<NetworkingConfigurationResponse>? = null, val processors: List<ProcessorResponse>, val provisioningState: String, val receivers: List<ReceiverResponse>, val replicas: Int? = null, val service: ServiceResponse)

Properties that need to be specified to create a new pipeline group instance.

Link copied to clipboard
data class PipelineResponse(val exporters: List<String>, val name: String, val processors: List<String>? = null, val receivers: List<String>, val type: String)

Pipeline Info.

Link copied to clipboard
data class PredictiveAutoscalePolicyResponse(val scaleLookAheadTime: String? = null, val scaleMode: String)

The parameters for enabling predictive autoscale.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse? = null, val type: String)

The Private Endpoint Connection resource.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class ProcessorResponse(val batch: BatchProcessorResponse? = null, val name: String, val type: String)

Processor Info.

Link copied to clipboard
data class ReceiverResponse(val name: String, val otlp: OtlpReceiverResponse? = null, val syslog: SyslogReceiverResponse? = null, val type: String, val udp: UdpReceiverResponse? = null)

Receiver Info.

Link copied to clipboard
data class RecordMapResponse(val from: String, val to: String)

Record map for schema in azure monitor.

Link copied to clipboard
data class RecurrenceResponse(val frequency: String, val schedule: RecurrentScheduleResponse)

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

Link copied to clipboard
data class RecurrentScheduleResponse(val days: List<String>, val hours: List<Int>, val minutes: List<Int>, val timeZone: String)

The scheduling constraints for when the profile begins.

Link copied to clipboard
data class ResourceMapResponse(val from: String, val to: String)

Resource map for schema in azure monitor.

Link copied to clipboard
data class RetentionPolicyResponse(val days: Int, val enabled: Boolean)

Specifies the retention policy for the log.

Link copied to clipboard
data class RuleResolveConfigurationResponse(val autoResolved: Boolean? = null, val timeToResolve: String? = null)

TBD. Relevant only for rules of the kind LogAlert.

Link copied to clipboard
data class ScaleActionResponse(val cooldown: String, val direction: String, val type: String, val value: String? = null)

The parameters for the scaling action.

Link copied to clipboard
data class ScaleCapacityResponse(val default: String, val maximum: String, val minimum: String)

The number of instances that can be used during this profile.

Link copied to clipboard
data class ScaleRuleMetricDimensionResponse(val dimensionName: String, val operator: String, val values: List<String>)

Specifies an auto scale rule metric dimension.

Link copied to clipboard
data class ScaleRuleResponse(val metricTrigger: MetricTriggerResponse, val scaleAction: ScaleActionResponse)

A rule that provide the triggers and parameters for the scaling action.

Link copied to clipboard

The rule criteria that defines the conditions of the scheduled query rule.

Link copied to clipboard
data class SchemaMapResponse(val recordMap: List<RecordMapResponse>, val resourceMap: List<ResourceMapResponse>? = null, val scopeMap: List<ScopeMapResponse>? = null)

Schema map for azure monitor for logs.

Link copied to clipboard
data class ScopeMapResponse(val from: String, val to: String)

Scope map for schema in azure monitor.

Link copied to clipboard
data class ServiceResponse(val persistence: PersistenceConfigurationsResponse? = null, val pipelines: List<PipelineResponse>)

Service Info.

Link copied to clipboard
data class SmsReceiverResponse(val countryCode: String, val name: String, val phoneNumber: String, val status: String)

An SMS receiver.

Link copied to clipboard
data class SubscriptionLogSettingsResponse(val category: String? = null, val categoryGroup: String? = null, val enabled: Boolean)

Part of Subscription diagnostic setting. Specifies the settings for a particular log.

Link copied to clipboard
data class SyslogReceiverResponse(val endpoint: String, val protocol: String? = null)

Base receiver using TCP as transport protocol.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TcpExporterResponse(val url: String)

Base exporter using TCP as transport protocol.

Link copied to clipboard
data class TimeWindowResponse(val end: String, val start: String, val timeZone: String? = null)

A specific date-time for the profile.

Link copied to clipboard
data class UdpReceiverResponse(val encoding: String? = null, val endpoint: String, val jsonArrayMapper: JsonArrayMapperResponse? = null, val readQueueLength: Int? = null)

Receiver using UDP as transport protocol.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class UserIdentityPropertiesResponse(val clientId: String, val principalId: String)

User assigned identity properties.

Link copied to clipboard
data class VoiceReceiverResponse(val countryCode: String, val name: String, val phoneNumber: String)

A voice receiver.

Link copied to clipboard
data class WebhookNotificationResponse(val properties: Map<String, String>? = null, val serviceUri: String? = null)

Webhook notification of an autoscale event.

Link copied to clipboard
data class WebhookReceiverResponse(val identifierUri: String? = null, val managedIdentity: String? = null, val name: String, val objectId: String? = null, val serviceUri: String, val tenantId: String? = null, val useAadAuth: Boolean? = null, val useCommonAlertSchema: Boolean? = null)

A webhook receiver.