Deployment Info - List

Service:

Elastic

API Version:

2020-07-01

Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo?api-version=2020-07-01

URI Parameters

Name	In	Required	Type	Description
monitorName	path	True	string	Monitor resource name
resourceGroupName	path	True	string	The name of the resource group to which the Elastic resource belongs.
subscriptionId	path	True	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
api-version	query	True	string	The API version to be used with the HTTP request.

Responses

Name	Type	Description
200 OK	DeploymentInfoResponse	Success
Other Status Codes	ResourceProviderDefaultErrorResponse	Default error response.

Examples

DeploymentInfo_List

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/listDeploymentInfo?api-version=2020-07-01

Go

package armelastic_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elastic/armelastic"
)

// x-ms-original-file: specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/DeploymentInfo_List.json
func ExampleDeploymentInfoClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armelastic.NewDeploymentInfoClient("<subscription-id>", cred, nil)
	_, err = client.List(ctx,
		"<resource-group-name>",
		"<monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

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

Sample response

Status code:

200

{
  "status": "Healthy",
  "version": "7.9.3",
  "memoryCapacity": "1024",
  "diskCapacity": "245760"
}

Definitions

Name	Description
DeploymentInfoResponse	The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.
ElasticDeploymentStatus	Flag specifying if the Elastic deployment status is healthy or not.
ErrorResponseBody	ErrorResponseBody
ResourceProviderDefaultErrorResponse	RP default error response.

DeploymentInfoResponse

Object

The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.

Name	Type	Description
diskCapacity	string	Disk capacity of the elasticsearch in Elastic cloud deployment.
memoryCapacity	string	RAM capacity of the elasticsearch in Elastic cloud deployment.
status	ElasticDeploymentStatus	The Elastic deployment status.
version	string	Version of the elasticsearch in Elastic cloud deployment.

ElasticDeploymentStatus

Enumeration

Flag specifying if the Elastic deployment status is healthy or not.

Value	Description
Healthy
Unhealthy

ErrorResponseBody

Object

ErrorResponseBody

Name	Type	Description
code	string	Error code.
details	ErrorResponseBody[]	Error details.
message	string	Error message.
target	string	Error target.

ResourceProviderDefaultErrorResponse

Object

RP default error response.

Name	Type	Description
error	ErrorResponseBody	ErrorResponseBody Response body of Error