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

2025/11/13 • 24 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents a paginated list of operations.",
        "old": "Result of GET request to list the Microsoft.Elastic operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The list of operations.",
            "old": "List of operations supported by the Microsoft.Elastic provider."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "display": [
                {
                  "#name": "provider",
                  "Description": {
                    "new": "The service provider of the operation.",
                    "old": "Service provider, i.e., Microsoft.Elastic."
                  }
                },
                {
                  "#name": "resource",
                  "Description": {
                    "new": "The resource type of the operation.",
                    "old": "Type on which the operation is performed, e.g., 'monitors'."
                  }
                },
                {
                  "#name": "operation",
                  "Description": {
                    "new": "The name of the operation.",
                    "old": "Operation type, e.g., read, write, delete, etc."
                  }
                },
                {
                  "#name": "description",
                  "Description": {
                    "new": "A description of the operation.",
                    "old": "Description of the operation, e.g., 'Write monitors'."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The URL to get the next set of results, if any.",
            "old": "URL to get the next set of operation list results if there are any."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: True ,
}
[
{
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: The service provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: The resource type of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
description:
{
Description: A description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get 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 (updated)
Description :  Retrieve a list of all available Elastic versions for a specified region, helping you choose the best version for your deployment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ElasticVersions_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ElasticVersionListFormat items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The ElasticVersionListFormat items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Elastic Version Properties ,
Required: False ,
}
{
version:
{
Description: Available elastic version of the given region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  >; /** Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organizations_GetElasticToAzureSubscriptionMapping",
  "Description": {
    "new": ">;\n  /**\nRetrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user.",
    "old": "Retrieve mapping details between the Elastic Organization and Azure Subscription for the logged-in user."
  }
}

⚼ 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_GetApiKey (updated)
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 ¶

⚶ Changes

{
  "#id": "Organizations_GetApiKey",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Email Id parameter of the User Organization, of which the API Key must be returned"
      }
    }
  ]
}

⚼ 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: The request body ,
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. ,
Format: password ,
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 (updated)
Description :  List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Monitors_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ElasticMonitorResource items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU.",
                    "old": "Name of the SKU."
                  }
                }
              ],
              "@removed_24639071012a46a4a9bd0a2da0f3ba4d": {
                "#name": "id",
                "Description": "ARM id of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_4976e53769ee457988128a5315333854": {
                "#name": "name",
                "Description": "Name of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_ec661f6a66e54410958a58f923f99f53": {
                "#name": "type",
                "Description": "The type of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_ac2ffcb45bf54ea5a781ea1032eaaa4d": {
                "#name": "tags",
                "Description": "The tags of the monitor resource.",
                "Required": false,
                "Type": "object"
              },
              "@removed_6c1c966383c04660a0b63d53f8173534": {
                "#name": "location",
                "Description": "The location of the monitor resource",
                "Required": true,
                "Type": "string"
              },
              "@removed_f0728796416d4630b63b4d5d2e34744d": {
                "#name": "systemData",
                "Description": "The system metadata relating to this resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The ElasticMonitorResource items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Monitors_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ElasticMonitorResource items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "sku": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "The name of the SKU.",
                    "old": "Name of the SKU."
                  }
                }
              ],
              "@removed_30bcbafb97da406a8ef6af156e68ca8a": {
                "#name": "id",
                "Description": "ARM id of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_f8d15a98ef654e54abb47a9914ec6feb": {
                "#name": "name",
                "Description": "Name of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_6734c107205c4533b1b0a9c516a49a1e": {
                "#name": "type",
                "Description": "The type of the monitor resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_2824d72b057c49eba96754d9d920fd2c": {
                "#name": "tags",
                "Description": "The tags of the monitor resource.",
                "Required": false,
                "Type": "object"
              },
              "@removed_99fb8727c6744c82ab029fe952f36385": {
                "#name": "location",
                "Description": "The location of the monitor resource",
                "Required": true,
                "Type": "string"
              },
              "@removed_7e9afc71ae5a4126b25701f40b67c3e6": {
                "#name": "systemData",
                "Description": "The system metadata relating to this resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The ElasticMonitorResource items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Monitors_Get",
  "$responses": {
    "200": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_ced9429a36b04c5686dd842b4d72449f": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c04b9bcf9ccc4276b8041e6cde30aa89": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_4a282193886b4e948388dd7717652ed0": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_47fb8525de934d21af5c6741fbf8491c": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_9fd44b17a8594202b539db393bd129cb": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_118ea62cd28d44bea8b0919909f2e6df": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ 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)

{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Monitors_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_251356ad9a264192a041575afc100ed0": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_9905dd23bea74a2b977e70b24fa39871": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_1888ceb6ef634370900668dc1e30ba0e": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_2520dd0eca774b228c306a335f63209d": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_9d687bbb4c034bf096e8d19e9b736464": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_2c3650bf4da94924aa23c995f22c1892": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_f85d6970dca341a0a8e20e4074e0b112": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_676b78bd16514dd5b1b6d608d8ec2799": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_006dd935a0404642a6db60792f66ea4f": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_246f9201f05841ecb7b519c4cff80d9e": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_2e8fd7068a7b4fda916c96982e79f686": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_8b6f0e3adeec404cb1b76379aa287424": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_2f6183e660d74292b265b9ed881ace5c": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_8ca8d57c855e4e38897234f6cf2d6efc": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_a5637560e96f4c4882b2557f566784a9": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_35aa47784dba40cdb023f50476763c0c": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_ff67dbad488d49ba816e658b0c2175c7": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_397e7a947ce14dd9876e2a97cfe0581b": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ 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:
{
Required: True ,
}
string ,
body:
{
Description: Elastic monitor resource model ,
Required: False ,
}
{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Monitor resource. ,
}
{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
}

⚐ 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 (updated)
Description :  Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Monitors_Update",
  "$responses": {
    "200": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_8a2349ee9b19458780d8443602d01e4b": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_82eca9eed2624a39b3964033b43be454": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_22cb4a8fa10142d391289697767cba55": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_2a1d639d5e6040edb6c3a304bca9f538": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_35441f33789143069d5c58cfdaf0d3a0": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_45bc3dc025e24426a4d58e7c34bd1ad5": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "202": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_f1932d46e7dd48498dc7fd9bbf6070c1": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bf6d7ae6461c42ff9461a62541971828": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_6f45cf904200461eafd4fc83c666e969": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_8756ef3265174507993293dbd527768c": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_82a7efe933544f7a951bcc9e73bd637b": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_6b5577543a6042b8b6b1908b2d107e58": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ 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:
{
Required: True ,
}
string ,
body:
{
Description: Elastic resource model update parameters. ,
Required: False ,
}
{
tags:
{
Description: elastic monitor resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: Monitor resource. ,
}
{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ConnectedPartnerResources_List (updated)
Description :  List all active deployments associated with the marketplace subscription linked to the given Elastic monitor resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedPartnerResources_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "List of all active elastic deployments.",
        "old": " List of all active elastic deployments."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConnectedPartnerResourcesListFormat items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The ConnectedPartnerResourcesListFormat items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
MonitoredResources_List (updated)
Description :  List all resources currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredResources_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The MonitoredResource items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The MonitoredResource items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
VMHost_List (updated)
Description :  List all VM resources currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚶ Changes

{
  "#id": "VMHost_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The VMResources items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next Vm resource Id, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The VMResources items on this page ,
Required: True ,
}
[
{
vmResourceId:
{
Description: The ARM id of the VM resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
MonitoredSubscriptions_List (updated)
Description :  List all subscriptions currently being monitored by the Elastic monitor resource, helping you manage observability.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredSubscriptions_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "monitoredSubscriptionList": {
                    "$properties": [
                      {
                        "#name": "subscriptionId",
                        "Required": {
                          "new": true,
                          "old": false
                        }
                      }
                    ]
                  }
                }
              ],
              "@removed_c07395c63e364254808aaa2d11472c12": {
                "#name": "name",
                "Description": "Name of the monitored subscription resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_4bca1519782b434797c4595b5a320b6f": {
                "#name": "id",
                "Description": "The id of the monitored subscription resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_9de08b996c63464683717460742cf8e9": {
                "#name": "type",
                "Description": "The type of the monitored subscription resource.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions
{
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: The MonitoredSubscriptionProperties items on this page ,
Required: True ,
}
[
{
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: True ,
}
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 ,
Format: uri ,
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 (updated)
Description :  Get detailed information about all subscriptions currently being monitored by the Elastic monitor resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredSubscriptions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_0ebd671196b74b22bd3f6d94da7c1588": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c187f859a42348c3be422ec28e686735": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_90b56b93bd944101b76dfda5ec029863": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
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 ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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: True ,
}
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 (updated)
Description :  Add subscriptions to be monitored by the Elastic monitor resource, enabling observability and monitoring.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredSubscriptions_CreateorUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_83b0616a47b044ef9fe1083e99724e0e": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_d1e34976bbd4419387129989e125dc6e": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7b3e27d97e9f436291700bb40d6f3f0c": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_74010421cacb44c7b90bfa53098af95b": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_34f2b2feb656421d8627fc6dd979378a": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_ce4ba11c9f004a699f204418f120b530": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_a4134877cb874d2280ab69cab9943ac4": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_91362396cf09463c996ab07fab38be6d": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0a4ab6616de14c63b2fb2f3043b30ae8": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
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:
{
Required: True ,
}
string ,
configurationName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
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: True ,
}
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)

{
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: True ,
}
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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The request to update subscriptions needed to be monitored by the Elastic monitor resource. ,
}
{
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: True ,
}
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 (updated)
Description :  Update subscriptions to be monitored by the Elastic monitor resource, ensuring optimal observability and performance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredSubscriptions_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_a2f51b115d7b471c9caa40c8ae8c431f": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_33403b85c8e1437c8b4358537717882c": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_5c9d9981b6bc41c6a8e915107f8e47c2": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "monitoredSubscriptionList": {
              "$properties": [
                {
                  "#name": "subscriptionId",
                  "Required": {
                    "new": true,
                    "old": false
                  }
                }
              ]
            }
          }
        ],
        "@removed_fd7854f088444f6bbd8d92cf4d1a42d4": {
          "#name": "name",
          "Description": "Name of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_80bcf46b70784e6a8142ea709a706eb2": {
          "#name": "id",
          "Description": "The id of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7e2b8bf68248467ebc1d1bf4105e2c6c": {
          "#name": "type",
          "Description": "The type of the monitored subscription resource.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "202": [
      {
        "@added_9709acc4d80a4747bcd29e1ea996867e": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
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:
{
Required: True ,
}
string ,
configurationName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
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: True ,
}
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)

{
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: True ,
}
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 (updated)
Description :  Delete subscriptions being monitored by the Elastic monitor resource, removing their observability and monitoring capabilities.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MonitoredSubscriptions_Delete",
  "$responses": {
    "202": [
      {
        "@added_5e07db455bb5474cb7d986326fb1c597": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
{
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 ,
configurationName:
{
Description: The configuration name. Only 'default' value is supported. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
OpenAI_List (updated)
Description :  List all OpenAI integration rules for a given Elastic monitor resource, helping you manage AI-driven observability and monitoring.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OpenAI_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OpenAIIntegrationRPModel items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_7aa09e4af29c4307bf7022082efa5160": {
                "#name": "name",
                "Description": "Name of the integration.",
                "Required": false,
                "Type": "string"
              },
              "@removed_a22be9e07f874dd9b3ec5b0c60ef12e6": {
                "#name": "id",
                "Description": "The id of the integration.",
                "Required": false,
                "Type": "string"
              },
              "@removed_d4e4b7979daa42648dc0fe1ab0d380bf": {
                "#name": "type",
                "Description": "The type of the integration.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The OpenAIIntegrationRPModel items on this page ,
Required: True ,
}
[
{
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 ,
Format: password ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get detailed information about OpenAI integration rules for a given Elastic monitor resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OpenAI_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_8e6e74e2da114c41a3cbe5c8915f5df8": {
          "#name": "name",
          "Description": "Name of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_d4b277d196cb40eb90b8f21e7ef7c893": {
          "#name": "id",
          "Description": "The id of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bcaf82cece88423590e59bbc368b6e09": {
          "#name": "type",
          "Description": "The type of the integration.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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)

{
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 ,
Format: password ,
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 (updated)
Description :  Create or update an OpenAI integration rule for a given Elastic monitor resource, enabling advanced AI-driven observability and monitoring.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OpenAI_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_a8d9814ea87a49cc8ae96e3cb8dc2322": {
          "#name": "name",
          "Description": "Name of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_f419efaec5304b5e8f35248c76905672": {
          "#name": "id",
          "Description": "The id of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_322d86e6df0f437088cbf8a779143275": {
          "#name": "type",
          "Description": "The type of the integration.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_755007bc599f496395318adf35c2bb32": {
          "#name": "name",
          "Description": "Name of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bdeafbd3a5734a5e95a4b72e04fd4868": {
          "#name": "id",
          "Description": "The id of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_07047d6ee4d043ae9ca642c5c4972e4d": {
          "#name": "type",
          "Description": "The type of the integration.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_674b75631c224233acab7da3b9c3cf75": {
          "#name": "name",
          "Description": "Name of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0a2aa33745054877956ec2c49ce66c47": {
          "#name": "id",
          "Description": "The id of the integration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_b07d06e0c8be40bb85eda9d831fb8c6f": {
          "#name": "type",
          "Description": "The type of the integration.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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:
{
Required: True ,
}
string ,
integrationName:
{
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
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 ,
Format: password ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
Format: password ,
Required: False ,
}
string ,
lastRefreshAt:
{
Description: Last Update Timestamp for key updation ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
Format: password ,
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 ,
]
,
}
,
}
Organizations_Resubscribe (updated)
Description :  Resubscribe the Elasticsearch Organization.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organizations_Resubscribe",
  "$responses": {
    "200": {
      "$properties": {
        "sku": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the SKU.",
              "old": "Name of the SKU."
            }
          }
        ],
        "@removed_7351b516bcc14ad89425478425e28626": {
          "#name": "id",
          "Description": "ARM id of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_4ae843e6a3ee49169356008a450980d8": {
          "#name": "name",
          "Description": "Name of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_06430305c88d471e822bca0536fcde54": {
          "#name": "type",
          "Description": "The type of the monitor resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_89ab47ab2df24bc2b73c1926be7512e0": {
          "#name": "tags",
          "Description": "The tags of the monitor resource.",
          "Required": false,
          "Type": "object"
        },
        "@removed_d37e6d5c6e8e41c096867e2bbdd502ef": {
          "#name": "location",
          "Description": "The location of the monitor resource",
          "Required": true,
          "Type": "string"
        },
        "@removed_259e10e1a4af420386c1b99f25ff2d8f": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "202": [
      {
        "@added_15ef4474ee204f42a783834736524361": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ 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)

{
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 ,
}
,
}
,
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: The name of the SKU. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
TagRules_List (updated)
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 ¶

⚶ Changes

{
  "#id": "TagRules_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The MonitoringTagRules items on this page",
            "old": "Results of a list operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_8096bc21eb6f416cbb1732058e7439e6": {
                "#name": "name",
                "Description": "Name of the rule set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_4edda6ae47574e7d912c5661825bbaa1": {
                "#name": "id",
                "Description": "The id of the rule set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_d9779104c88442c4bfb2694404e943b1": {
                "#name": "type",
                "Description": "The type of the rule set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_f94f9ef358244efc9690e0bedf827a0f": {
                "#name": "systemData",
                "Description": "The system metadata relating to this resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next set of results, if any."
          }
        }
      ]
    }
  }
}

⚼ 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: The MonitoringTagRules items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get detailed information about a tag rule set for a given Elastic monitor resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TagRules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_99e55f2f313c428395445f24d3136525": {
          "#name": "name",
          "Description": "Name of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_ed8ef2409f11426789c7958e5ea84e52": {
          "#name": "id",
          "Description": "The id of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_534182f8e5434cd6abf54d3a3c809db1": {
          "#name": "type",
          "Description": "The type of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_2fcf686110c341c6885d6ef7f1f65b14": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ 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)

{
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 ,
}
,
]
,
}
,
}
,
}

⚐ 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 (updated)
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 ¶

⚶ Changes

{
  "#id": "TagRules_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_1946f91c27ed4811b3f7323c193d8272": {
          "#name": "name",
          "Description": "Name of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7e224563fdc44aa5b940e13e461ede83": {
          "#name": "id",
          "Description": "The id of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_f6b03872c097434bb1c0e93cbaa9f096": {
          "#name": "type",
          "Description": "The type of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0030cee154bf4df791cd77b48d3fcbc2": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_9702b4d7418a4cd98e9b54c5d5dd1c50": {
          "#name": "name",
          "Description": "Name of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_de99fc79e60d45bc9fa767c3b2bf31bd": {
          "#name": "id",
          "Description": "The id of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_88af251a31e94b30ab8b370b97a3b65e": {
          "#name": "type",
          "Description": "The type of the rule set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_f56ce59bf45144c08e1d78b5541e0b29": {
          "#name": "systemData",
          "Description": "The system metadata relating to this resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ 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:
{
Required: True ,
}
string ,
ruleSetName:
{
Required: True ,
}
string ,
body:
{
Description: request body of MonitoringTagRules ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
]
,
}
,
}