Private Link Scope Operation Status - Get

Reference

Service:: Monitor

API Version:: 2019-10-17-preview

Get the status of an azure asynchronous operation associated with a private link scope operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/privateLinkScopeOperationStatuses/{asyncOperationId}?api-version=2019-10-17-preview

URI Parameters

Name	In	Required	Type	Description
asyncOperationId	path	True	string	The operation Id.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationStatus	OK. Operation status.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get specific operation status

Sample request

GET https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/MyResourceGroup/providers/microsoft.insights/privateLinkScopeOperationStatuses/713192d7-503f-477a-9cfe-4efc3ee2bd11?api-version=2019-10-17-preview

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/privateLinkScopeOperationStatuses.json
func ExamplePrivateLinkScopeOperationStatusClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewPrivateLinkScopeOperationStatusClient("613192d7-503f-477a-9cfe-4efc3ee2bd60", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"713192d7-503f-477a-9cfe-4efc3ee2bd11",
		"MyResourceGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

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

/**
 * This sample demonstrates how to Get the status of an azure asynchronous operation associated with a private link scope operation.
 *
 * @summary Get the status of an azure asynchronous operation associated with a private link scope operation.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/examples/privateLinkScopeOperationStatuses.json
 */
async function getSpecificOperationStatus() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const asyncOperationId = "713192d7-503f-477a-9cfe-4efc3ee2bd11";
  const resourceGroupName = "MyResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.privateLinkScopeOperationStatus.get(
    asyncOperationId,
    resourceGroupName
  );
  console.log(result);
}

getSpecificOperationStatus().catch(console.error);

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

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/713192d7-503f-477a-9cfe-4efc3ee2bd11",
  "name": "713192d7-503f-477a-9cfe-4efc3ee2bd11",
  "startTime": "2017-01-01T13:13:13.933Z",
  "endTime": "2017-01-01T16:13:13.933Z",
  "status": "Succeeded"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponseCommon	The resource management error response.
OperationStatus	The status of operation.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorResponseCommon

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	Error code
details	ErrorResponseCommon[]	The error details.
message	string	Error message indicating why the operation failed.

OperationStatus

The status of operation.

Name	Type	Description
endTime	string	End time of the job in standard ISO8601 format.
error	ErrorResponseCommon	The error detail of the operation if any.
id	string	The operation Id.
name	string	The operation name.
startTime	string	Start time of the job in standard ISO8601 format.
status	string	The status of the operation.

Share via