Microsoft.Elastic (stable:2025-06-01)

2025/06/19 • 43 new methods

Operations_List (new)
Description :  List all operations provided by Microsoft.Elastic.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Elastic/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Microsoft.Elastic provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, i.e., {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider, i.e., Microsoft.Elastic. ,
Required: False ,
}
string ,
resource:
{
Description: Type on which the operation is performed, e.g., 'monitors'. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type, e.g., read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation, e.g., 'Write monitors'. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitors_List (new)
Description :  List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ElasticVersions_List (new)
Description :  Retrieve a list of all available Elastic versions for a specified region, helping you choose the best version for your deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
region:
{
Description: Region where elastic deployment will take place. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Elastic Version Properties ,
Required: False ,
}
{
version:
{
Description: Available elastic version of the given region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitors_ListByResourceGroup (new)
Description :  List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitors_Get (new)
Description :  Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitors_Create (new)
Description :  Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: Elastic monitor resource model ,
Required: False ,
}
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitors_Update (new)
Description :  Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: Elastic resource model update parameters. ,
Required: False ,
}
{
tags:
{
Description: elastic monitor resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Monitor resource. ,
}
{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Monitors_Delete (new)
Description :  Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MonitoredSubscriptions_List (new)
Description :  List all subscriptions currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MonitoredSubscriptions_Get (new)
Description :  Get detailed information about all subscriptions currently being monitored by the Elastic monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MonitoredSubscriptions_CreateorUpdate (new)
Description :  Add subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MonitoredSubscriptions_Update (new)
Description :  Update subscriptions to be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the monitored subscription resource. ,
Required: False ,
}
string ,
id:
{
Description: The id of the monitored subscription resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitored subscription resource. ,
Required: False ,
}
string ,
properties:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
Required: False ,
}
{
operation:
{
Description: The operation for the patch on the resource. ,
Enum:
{
AddBegin: No description available. ,
AddComplete: No description available. ,
DeleteBegin: No description available. ,
DeleteComplete: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
monitoredSubscriptionList:
{
Description: List of subscriptions and the state of the monitoring. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: The subscriptionId to be monitored. ,
Required: False ,
}
string ,
status:
{
Description: The state of monitoring. ,
Enum:
{
InProgress: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The reason of not monitoring the subscription. ,
Required: False ,
}
string ,
tagRules:
{
Description: Definition of the properties for a TagRules resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
provisioningState:
{
Description: Provisioning State of the resource ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MonitoredSubscriptions_Delete (new)
Description :  Delete subscriptions being monitored by the Elastic monitor resource, removing their observability and monitoring capabilities.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MonitoredResources_List (new)
Description :  List all resources currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
id:
{
Description: The ARM id of the resource. ,
Required: False ,
}
string ,
sendingLogs:
{
Description: Flag indicating the status of the resource for sending logs operation to Elastic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
reasonForLogsStatus:
{
Description: Reason for why the resource is sending logs (or why it is not sending). ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DeploymentInfo_List (new)
Description :  Fetch detailed information about Elastic cloud deployments corresponding to the Elastic monitor resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The Elastic deployment status. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Version of the elasticsearch in Elastic cloud deployment. ,
Required: False ,
}
string ,
memoryCapacity:
{
Description: RAM capacity of the elasticsearch in Elastic cloud deployment. ,
Required: False ,
}
string ,
diskCapacity:
{
Description: Disk capacity of the elasticsearch in Elastic cloud deployment. ,
Required: False ,
}
string ,
elasticsearchEndPoint:
{
Description: Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise. ,
Required: False ,
}
string ,
deploymentUrl:
{
Description: Deployment URL of the elasticsearch in Elastic cloud deployment. ,
Required: False ,
}
string ,
marketplaceSaasInfo:
{
Description: Marketplace SaaS Info of the resource. ,
Required: False ,
}
{
marketplaceSubscription:
{
Description: Marketplace Subscription ,
Required: False ,
}
{
id:
{
Description: Marketplace Subscription Id. This is a GUID-formatted string. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher Id of the Marketplace offer. ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id of the Marketplace offer, ,
Required: False ,
}
string ,
}
,
marketplaceName:
{
Description: Marketplace Subscription Details: SAAS Name ,
Required: False ,
}
string ,
marketplaceResourceId:
{
Description: Marketplace Subscription Details: Resource URI ,
Required: False ,
}
string ,
marketplaceStatus:
{
Description: Marketplace Subscription Details: SaaS Subscription Status ,
Required: False ,
}
string ,
billedAzureSubscriptionId:
{
Description: The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. ,
Required: False ,
}
string ,
subscribed:
{
Description: Flag specifying if the Marketplace status is subscribed or not. ,
Required: False ,
}
boolean ,
}
,
projectType:
{
Description: Project Type - Applicable for Serverless only. ,
Required: False ,
}
string ,
configurationType:
{
Description: ConfigurationType Type - Applicable for Serverless only. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ExternalUser_CreateOrUpdate (new)
Description :  Create or update external user configurations for your Elastic monitor resource, enabling access and management by external users.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: Elastic External User Creation Parameters ,
Required: False ,
}
{
userName:
{
Description: Username of the user to be created or updated ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the user to be created or updated ,
Required: False ,
}
string ,
password:
{
Description: Password of the user to be created or updated ,
Required: False ,
}
string ,
emailId:
{
Description: Email id of the user to be created or updated ,
Required: False ,
}
string ,
roles:
{
Description: Roles to be assigned for created or updated user ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
created:
{
Description: Shows if user is created or updated ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BillingInfo_Get (new)
Description :  Retrieve marketplace and organization billing information mapped to the given Elastic monitor resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
marketplaceSaasInfo:
{
Description: Marketplace Subscription details ,
Required: False ,
}
{
marketplaceSubscription:
{
Description: Marketplace Subscription ,
Required: False ,
}
{
id:
{
Description: Marketplace Subscription Id. This is a GUID-formatted string. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher Id of the Marketplace offer. ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id of the Marketplace offer, ,
Required: False ,
}
string ,
}
,
marketplaceName:
{
Description: Marketplace Subscription Details: SAAS Name ,
Required: False ,
}
string ,
marketplaceResourceId:
{
Description: Marketplace Subscription Details: Resource URI ,
Required: False ,
}
string ,
marketplaceStatus:
{
Description: Marketplace Subscription Details: SaaS Subscription Status ,
Required: False ,
}
string ,
billedAzureSubscriptionId:
{
Description: The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. ,
Required: False ,
}
string ,
subscribed:
{
Description: Flag specifying if the Marketplace status is subscribed or not. ,
Required: False ,
}
boolean ,
}
,
partnerBillingEntity:
{
Description: Partner Billing Entity details: Organization Info ,
Required: False ,
}
{
id:
{
Description: The Elastic Organization Id. ,
Required: False ,
}
string ,
name:
{
Description: The Elastic Organization Name. ,
Required: False ,
}
string ,
partnerEntityUri:
{
Description: Link to the elastic organization page ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ConnectedPartnerResources_List (new)
Description :  List all active deployments associated with the marketplace subscription linked to the given Elastic monitor resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
properties:
{
Description: Connected Partner Resource Properties ,
Required: False ,
}
{
partnerDeploymentName:
{
Description: Elastic resource name ,
Required: False ,
}
string ,
partnerDeploymentUri:
{
Description: URL of the resource in Elastic cloud. ,
Required: False ,
}
string ,
azureResourceId:
{
Description: The azure resource Id of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The hosting type of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenAI_List (new)
Description :  List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the integration. ,
Required: False ,
}
string ,
id:
{
Description: The id of the integration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the integration. ,
Required: False ,
}
string ,
properties:
{
Description: Open AI Integration details. ,
Required: False ,
}
{
openAIResourceId:
{
Description: The resource name of Open AI resource ,
Required: False ,
}
string ,
openAIResourceEndpoint:
{
Description: The API endpoint for Open AI resource ,
Required: False ,
}
string ,
openAIConnectorId:
{
Description: The connector id of Open AI resource ,
Required: False ,
}
string ,
key:
{
Description: Value of API key for Open AI resource ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenAI_Get (new)
Description :  Get detailed information about OpenAI integration rules for a given Elastic monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
integrationName:
{
Description: OpenAI Integration name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the integration. ,
Required: False ,
}
string ,
id:
{
Description: The id of the integration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the integration. ,
Required: False ,
}
string ,
properties:
{
Description: Open AI Integration details. ,
Required: False ,
}
{
openAIResourceId:
{
Description: The resource name of Open AI resource ,
Required: False ,
}
string ,
openAIResourceEndpoint:
{
Description: The API endpoint for Open AI resource ,
Required: False ,
}
string ,
openAIConnectorId:
{
Description: The connector id of Open AI resource ,
Required: False ,
}
string ,
key:
{
Description: Value of API key for Open AI resource ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenAI_CreateOrUpdate (new)
Description :  Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
integrationName:
{
Description: OpenAI Integration name ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
name:
{
Description: Name of the integration. ,
Required: False ,
}
string ,
id:
{
Description: The id of the integration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the integration. ,
Required: False ,
}
string ,
properties:
{
Description: Open AI Integration details. ,
Required: False ,
}
{
openAIResourceId:
{
Description: The resource name of Open AI resource ,
Required: False ,
}
string ,
openAIResourceEndpoint:
{
Description: The API endpoint for Open AI resource ,
Required: False ,
}
string ,
openAIConnectorId:
{
Description: The connector id of Open AI resource ,
Required: False ,
}
string ,
key:
{
Description: Value of API key for Open AI resource ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the integration. ,
Required: False ,
}
string ,
id:
{
Description: The id of the integration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the integration. ,
Required: False ,
}
string ,
properties:
{
Description: Open AI Integration details. ,
Required: False ,
}
{
openAIResourceId:
{
Description: The resource name of Open AI resource ,
Required: False ,
}
string ,
openAIResourceEndpoint:
{
Description: The API endpoint for Open AI resource ,
Required: False ,
}
string ,
openAIConnectorId:
{
Description: The connector id of Open AI resource ,
Required: False ,
}
string ,
key:
{
Description: Value of API key for Open AI resource ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
name:
{
Description: Name of the integration. ,
Required: False ,
}
string ,
id:
{
Description: The id of the integration. ,
Required: False ,
}
string ,
type:
{
Description: The type of the integration. ,
Required: False ,
}
string ,
properties:
{
Description: Open AI Integration details. ,
Required: False ,
}
{
openAIResourceId:
{
Description: The resource name of Open AI resource ,
Required: False ,
}
string ,
openAIResourceEndpoint:
{
Description: The API endpoint for Open AI resource ,
Required: False ,
}
string ,
openAIConnectorId:
{
Description: The connector id of Open AI resource ,
Required: False ,
}
string ,
key:
{
Description: Value of API key for Open AI resource ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenAI_Delete (new)
Description :  Delete an OpenAI integration rule for a given Elastic monitor resource, removing AI-driven observability and monitoring capabilities.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
integrationName:
{
Description: OpenAI Integration name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OpenAI_GetStatus (new)
Description :  Get the status of OpenAI integration for a given Elastic monitor resource, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}/getStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
integrationName:
{
Description: OpenAI Integration name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Status of the OpenAI Integration ,
Required: False ,
}
{
status:
{
Description: Status of the OpenAI Integration ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TagRules_List (new)
Description :  List all tag rules for a given Elastic monitor resource, helping you manage fine-grained control over observability based on resource tags.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitoring tag rules. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TagRules_CreateOrUpdate (new)
Description :  Create or update a tag rule set for a given Elastic monitor resource, enabling fine-grained control over observability based on resource tags.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Tag Rule Set resource name ,
Required: True ,
}
string ,
body:
{
Description: request body of MonitoringTagRules ,
Required: False ,
}
{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitoring tag rules. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitoring tag rules. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TagRules_Get (new)
Description :  Get detailed information about a tag rule set for a given Elastic monitor resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Tag Rule Set resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the rule set. ,
Required: False ,
}
string ,
id:
{
Description: The id of the rule set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the rule set. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the monitoring tag rules. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitoring tag rules. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
logRules:
{
Description: Rules for sending logs. ,
Required: False ,
}
{
sendAadLogs:
{
Description: Flag specifying if AAD logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendSubscriptionLogs:
{
Description: Flag specifying if subscription logs should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
sendActivityLogs:
{
Description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. ,
Required: False ,
}
boolean ,
filteringTags:
{
Description: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. ,
Required: False ,
}
[
{
name:
{
Description: The name (also known as the key) of the tag. ,
Required: False ,
}
string ,
value:
{
Description: The value of the tag. ,
Required: False ,
}
string ,
action:
{
Description: Valid actions for a filtering tag. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TagRules_Delete (new)
Description :  Delete a tag rule set for a given Elastic monitor resource, removing fine-grained control over observability based on resource tags.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Tag Rule Set resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
VMHost_List (new)
Description :  List all VM resources currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of a list operation. ,
Required: False ,
}
[
{
vmResourceId:
{
Description: The ARM id of the VM resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next Vm resource Id, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
VMIngestion_Details (new)
Description :  List detailed information about VM ingestion that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
cloudId:
{
Description: The cloudId of given Elastic monitor resource. ,
Required: False ,
}
string ,
ingestionKey:
{
Description: Ingestion details to install agent on given VM. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
VMCollection_Update (new)
Description :  Update the VM details that will be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: VM resource Id ,
Required: False ,
}
{
vmResourceId:
{
Description: ARM id of the VM resource. ,
Required: False ,
}
string ,
operationName:
{
Description: Operation to be performed for given VM. ,
Enum:
{
Add: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
UpgradableVersions_Details (new)
Description :  List all upgradable versions for your Elastic monitor resource, helping you plan and execute upgrades.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
currentVersion:
{
Description: Current version of the elastic monitor ,
Required: False ,
}
string ,
upgradableVersions:
{
Description: Stack Versions that this version can upgrade to ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Monitor_Upgrade (new)
Description :  Upgrade the Elastic monitor resource to a newer version, ensuring optimal observability and performance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: Elastic Monitor Upgrade Parameters ,
Required: False ,
}
{
version:
{
Description: Version to which the elastic monitor should be upgraded to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AllTrafficFilters_list (new)
Description :  List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
rulesets:
{
Description: List of elastic traffic filters in the account ,
Required: False ,
}
[
{
id:
{
Description: Id of the elastic filter ,
Required: False ,
}
string ,
name:
{
Description: Name of the elastic filter ,
Required: False ,
}
string ,
description:
{
Description: Description of the elastic filter ,
Required: False ,
}
string ,
region:
{
Description: Region of the elastic filter ,
Required: False ,
}
string ,
type:
{
Description: Type of the elastic filter ,
Enum:
{
ip: No description available. ,
azure_private_endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
includeByDefault:
{
Description: IncludeByDefault for the elastic filter ,
Required: False ,
}
boolean ,
rules:
{
Description: Rules in the elastic filter ,
Required: False ,
}
[
{
source:
{
Description: IP of the elastic filter rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the elastic filter rule ,
Required: False ,
}
string ,
azureEndpointGuid:
{
Description: Guid of Private Endpoint in the elastic filter rule ,
Required: False ,
}
string ,
azureEndpointName:
{
Description: Name of the Private Endpoint in the elastic filter rule ,
Required: False ,
}
string ,
id:
{
Description: Id of the elastic filter rule ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
listAssociatedTrafficFilters_list (new)
Description :  List all traffic filters associated with your Elastic monitor resource, helping you manage network traffic control.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
rulesets:
{
Description: List of elastic traffic filters in the account ,
Required: False ,
}
[
{
id:
{
Description: Id of the elastic filter ,
Required: False ,
}
string ,
name:
{
Description: Name of the elastic filter ,
Required: False ,
}
string ,
description:
{
Description: Description of the elastic filter ,
Required: False ,
}
string ,
region:
{
Description: Region of the elastic filter ,
Required: False ,
}
string ,
type:
{
Description: Type of the elastic filter ,
Enum:
{
ip: No description available. ,
azure_private_endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
includeByDefault:
{
Description: IncludeByDefault for the elastic filter ,
Required: False ,
}
boolean ,
rules:
{
Description: Rules in the elastic filter ,
Required: False ,
}
[
{
source:
{
Description: IP of the elastic filter rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the elastic filter rule ,
Required: False ,
}
string ,
azureEndpointGuid:
{
Description: Guid of Private Endpoint in the elastic filter rule ,
Required: False ,
}
string ,
azureEndpointName:
{
Description: Name of the Private Endpoint in the elastic filter rule ,
Required: False ,
}
string ,
id:
{
Description: Id of the elastic filter rule ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
createAndAssociateIPFilter_Create (new)
Description :  Create and associate an IP filter with your Elastic monitor resource to control and manage network traffic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
ips:
{
Description: List of ips ,
Required: False ,
}
string ,
name:
{
Description: Name of the traffic filter ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
createAndAssociatePLFilter_Create (new)
Description :  Create and associate a PL filter with your Elastic monitor resource to control and manage network traffic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
name:
{
Description: Name of the traffic filter ,
Required: False ,
}
string ,
privateEndpointGuid:
{
Description: Guid of the private endpoint ,
Required: False ,
}
string ,
privateEndpointName:
{
Description: Name of the private endpoint ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssociateTrafficFilter_Associate (new)
Description :  Associate a traffic filter with your Elastic monitor resource to control and manage network traffic.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
rulesetId:
{
Description: Ruleset Id of the filter ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DetachAndDeleteTrafficFilter_Delete (new)
Description :  Detach and delete an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
rulesetId:
{
Description: Ruleset Id of the filter ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DetachTrafficFilter_Update (new)
Description :  Detach an existing traffic filter from your Elastic monitor resource, removing its network traffic control capabilities.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
rulesetId:
{
Description: Ruleset Id of the filter ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TrafficFilters_Delete (new)
Description :  Delete an existing traffic filter associated with your Elastic monitor resource, removing its network traffic control capabilities.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
rulesetId:
{
Description: Ruleset Id of the filter ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organizations_GetApiKey (new)
Description :  Fetch the User API Key from the internal database, if it was generated and stored during the creation of the Elasticsearch Organization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: Email Id parameter of the User Organization, of which the API Key must be returned ,
Required: False ,
}
{
emailId:
{
Description: The User email Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
apiKey:
{
Description: The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organizations_GetElasticToAzureSubscriptionMapping (new)
Description :  Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into. ,
Required: False ,
}
{
billedAzureSubscriptionId:
{
Description: The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization. ,
Required: False ,
}
string ,
marketplaceSaasInfo:
{
Description: Marketplace SaaS Info of the resource. ,
Required: False ,
}
{
marketplaceSubscription:
{
Description: Marketplace Subscription ,
Required: False ,
}
{
id:
{
Description: Marketplace Subscription Id. This is a GUID-formatted string. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher Id of the Marketplace offer. ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id of the Marketplace offer, ,
Required: False ,
}
string ,
}
,
marketplaceName:
{
Description: Marketplace Subscription Details: SAAS Name ,
Required: False ,
}
string ,
marketplaceResourceId:
{
Description: Marketplace Subscription Details: Resource URI ,
Required: False ,
}
string ,
marketplaceStatus:
{
Description: Marketplace Subscription Details: SaaS Subscription Status ,
Required: False ,
}
string ,
billedAzureSubscriptionId:
{
Description: The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. ,
Required: False ,
}
string ,
subscribed:
{
Description: Flag specifying if the Marketplace status is subscribed or not. ,
Required: False ,
}
boolean ,
}
,
elasticOrganizationId:
{
Description: The Elastic Organization Id. ,
Required: False ,
}
string ,
elasticOrganizationName:
{
Description: The Elastic Organization Name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Response body of Error ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Organizations_Resubscribe (new)
Description :  Resubscribe the Elasticsearch Organization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/resubscribe
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
monitorName:
{
Description: Monitor resource name ,
Required: True ,
}
string ,
body:
{
Description: Resubscribe Properties ,
Required: False ,
}
{
planId:
{
Description: Newly selected plan Id to create the new Marketplace subscription for Resubscribe ,
Required: False ,
}
string ,
term:
{
Description: Newly selected term to create the new Marketplace subscription for Resubscribe ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe ,
Required: False ,
}
string ,
organizationId:
{
Description: Organization Id of the Elastic Organization that needs to be resubscribed ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: ARM id of the monitor resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the monitor resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the monitor resource. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of the Elastic resource - observability, security, search etc. ,
Required: False ,
}
string ,
sku:
{
Description: SKU of the monitor resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: Properties of the monitor resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the monitor resource. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleted: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
monitoringStatus:
{
Description: Flag specifying if the resource monitoring is enabled or disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
elasticProperties:
{
Description: Elastic cloud properties. ,
Required: False ,
}
{
elasticCloudUser:
{
Description: Details of the user's elastic account. ,
Required: False ,
}
{
emailAddress:
{
Description: Email of the Elastic User Account. ,
Required: False ,
}
string ,
id:
{
Description: User Id of the elastic account of the User. ,
Required: False ,
}
string ,
elasticCloudSsoDefaultUrl:
{
Description: Elastic cloud default dashboard sso URL of the Elastic user account. ,
Required: False ,
}
string ,
}
,
elasticCloudDeployment:
{
Description: Details of the elastic cloud deployment. ,
Required: False ,
}
{
name:
{
Description: Elastic deployment name ,
Required: False ,
}
string ,
deploymentId:
{
Description: Elastic deployment Id ,
Required: False ,
}
string ,
azureSubscriptionId:
{
Description: Associated Azure subscription Id for the elastic deployment. ,
Required: False ,
}
string ,
elasticsearchRegion:
{
Description: Region where Deployment at Elastic side took place. ,
Required: False ,
}
string ,
elasticsearchServiceUrl:
{
Description: Elasticsearch ingestion endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaServiceUrl:
{
Description: Kibana endpoint of the Elastic deployment. ,
Required: False ,
}
string ,
kibanaSsoUrl:
{
Description: Kibana dashboard sso URL of the Elastic deployment. ,
Required: False ,
}
string ,
}
,
}
,
userInfo:
{
Description: User information. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
companyName:
{
Description: Company name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email of the user used by Elastic for contacting them if needed ,
Required: False ,
}
string ,
companyInfo:
{
Description: Company information of the user to be passed to partners. ,
Required: False ,
}
{
domain:
{
Description: Domain of the company ,
Required: False ,
}
string ,
business:
{
Description: Business of the company ,
Required: False ,
}
string ,
employeesNumber:
{
Description: Number of employees in the company ,
Required: False ,
}
string ,
state:
{
Description: State of the company location. ,
Required: False ,
}
string ,
country:
{
Description: Country of the company location. ,
Required: False ,
}
string ,
}
,
}
,
planDetails:
{
Description: Plan details of the monitor resource. ,
Required: False ,
}
{
offerID:
{
Description: Offer ID of the plan ,
Required: False ,
}
string ,
publisherID:
{
Description: Publisher ID of the plan ,
Required: False ,
}
string ,
termID:
{
Description: Term ID of the plan ,
Required: False ,
}
string ,
planID:
{
Description: Plan ID ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name ,
Required: False ,
}
string ,
}
,
version:
{
Description: Version of elastic of the monitor resource ,
Required: False ,
}
string ,
subscriptionState:
{
Description: State of the Azure Subscription containing the monitor resource ,
Required: False ,
}
string ,
saaSAzureSubscriptionStatus:
{
Description: Status of Azure Subscription where Marketplace SaaS is located. ,
Required: False ,
}
string ,
sourceCampaignName:
{
Description: Name of the marketing campaign. ,
Required: False ,
}
string ,
sourceCampaignId:
{
Description: A unique identifier associated with the campaign. ,
Required: False ,
}
string ,
liftrResourceCategory:
{
Enum:
{
Unknown: No description available. ,
MonitorLogs: No description available. ,
}
,
Required: False ,
}
enum ,
liftrResourcePreference:
{
Description: The priority of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
generateApiKey:
{
Description: Flag to determine if User API Key has to be generated and shared. ,
Required: False ,
}
boolean ,
hostingType:
{
Description: Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. ,
Enum:
{
Hosted: No description available. ,
Serverless: No description available. ,
}
,
Required: False ,
}
enum ,
projectDetails:
{
Description: Project details of the monitor resource IF it belongs to Serverless offer kind. ,
Required: False ,
}
{
projectType:
{
Description: Project type; ex: Elasticsearch / Observability / Security ,
Enum:
{
Elasticsearch: No description available. ,
Observability: No description available. ,
Security: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
configurationType:
{
Description: Configuration type of the Elasticsearch project ,
Enum:
{
GeneralPurpose: No description available. ,
Vector: No description available. ,
TimeSeries: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: Identity properties of the monitor resource. ,
Required: False ,
}
{
principalId:
{
Description: The identity ID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Managed identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The tags of the monitor resource. ,
Required: False ,
}
object ,
location:
{
Description: The location of the monitor resource ,
Required: True ,
}
string ,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}