Operations - Get

Service:

Dev Test Labs

API Version:

2018-09-15

Get operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}?api-version=2018-09-15

URI Parameters

Name	In	Required	Type	Description
locationName	path	True	string	The name of the location.
name	path	True	string	The name of the operation.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	OperationResult	OK
202 Accepted	OperationResult	Accepted
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

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

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Examples

Operations_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{operationName}?api-version=2018-09-15

Java

/** Samples for Operations Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Operations_Get.json
     */
    /**
     * Sample code: Operations_Get.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void operationsGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.operations().getWithResponse("{locationName}", "{operationName}", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python operations_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.operations.get(
        location_name="{locationName}",
        name="{operationName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Operations_Get.json
if __name__ == "__main__":
    main()

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

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Operations_Get.json
func ExampleOperationsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().Get(ctx, "{locationName}", "{operationName}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResult = armdevtestlabs.OperationResult{
	// 	Status: to.Ptr("Running"),
	// 	StatusCode: to.Ptr(armdevtestlabs.HTTPStatusCodeOK),
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Get operation.
 *
 * @summary Get operation.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Operations_Get.json
 */
async function operationsGet() {
  const subscriptionId = "{subscriptionId}";
  const locationName = "{locationName}";
  const name = "{operationName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.operations.get(locationName, name);
  console.log(result);
}

operationsGet().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

{
  "status": "Running",
  "statusCode": "OK"
}

Status code:

202

{
  "status": "Running",
  "statusCode": "Accepted"
}

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
HttpStatusCode	The status code for the operation.
OperationError	Error details for the operation in case of a failure.
OperationResult	An Operation Result

CloudError

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name	Type	Description
code	string	The error code.
details	CloudErrorBody[]	Inner errors.
message	string	The error message.
target	string	The error target.

HttpStatusCode

The status code for the operation.

Name	Type	Description
Accepted	string
Ambiguous	string
BadGateway	string
BadRequest	string
Conflict	string
Continue	string
Created	string
ExpectationFailed	string
Forbidden	string
Found	string
GatewayTimeout	string
Gone	string
HttpVersionNotSupported	string
InternalServerError	string
LengthRequired	string
MethodNotAllowed	string
Moved	string
MovedPermanently	string
MultipleChoices	string
NoContent	string
NonAuthoritativeInformation	string
NotAcceptable	string
NotFound	string
NotImplemented	string
NotModified	string
OK	string
PartialContent	string
PaymentRequired	string
PreconditionFailed	string
ProxyAuthenticationRequired	string
Redirect	string
RedirectKeepVerb	string
RedirectMethod	string
RequestEntityTooLarge	string
RequestTimeout	string
RequestUriTooLong	string
RequestedRangeNotSatisfiable	string
ResetContent	string
SeeOther	string
ServiceUnavailable	string
SwitchingProtocols	string
TemporaryRedirect	string
Unauthorized	string
UnsupportedMediaType	string
Unused	string
UpgradeRequired	string
UseProxy	string

OperationError

Error details for the operation in case of a failure.

Name	Type	Description
code	string	The error code of the operation error.
message	string	The error message of the operation error.

OperationResult

An Operation Result

Name	Type	Description
error	OperationError	Error details for the operation in case of a failure.
status	string	The operation status.
statusCode	HttpStatusCode	The status code for the operation.