Policies - Get

Dienst:

Dev Test Labs

API-Version:

2018-09-15

Richtlinie abrufen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}?api-version=2018-09-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}?$expand={$expand}&api-version=2018-09-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labors.
name	path	True	string	Der Name der Richtlinie.
policySetName	path	True	string	Der Name des Richtliniensatzes.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Client-API-Version.
$expand	query		string	Geben Sie die $expand Abfrage an. Beispiel: "properties($select=description)"

Antworten

Name	Typ	Beschreibung
200 OK	Policy	OKAY
Other Status Codes	CloudError	Ungültige Anfrage

Sicherheit

azure_auth

Implizite OAuth2-Gewährung

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Zugreifen auf Microsoft Azure

Beispiele

Policies_Get

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}?api-version=2018-09-15

Java

/**
 * Samples for Policies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_Get.json
     */
    /**
     * Sample code: Policies_Get.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void policiesGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.policies().getWithResponse("resourceGroupName", "{labName}", "{policySetName}", "{policyName}", null,
            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 policies_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.policies.get(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        policy_set_name="{policySetName}",
        name="{policyName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_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/Policies_Get.json
func ExamplePoliciesClient_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.NewPoliciesClient().Get(ctx, "resourceGroupName", "{labName}", "{policySetName}", "{policyName}", &armdevtestlabs.PoliciesClientGetOptions{Expand: 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.Policy = armdevtestlabs.Policy{
	// 	Properties: &armdevtestlabs.PolicyProperties{
	// 		Description: to.Ptr("{policyDescription}"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		EvaluatorType: to.Ptr(armdevtestlabs.PolicyEvaluatorType("{policyEvaluatorType}")),
	// 		FactData: to.Ptr("{policyFactData}"),
	// 		FactName: to.Ptr(armdevtestlabs.PolicyFactName("{policyFactName}")),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Status: to.Ptr(armdevtestlabs.PolicyStatus("{policyStatus}")),
	// 		Threshold: to.Ptr("{policyThreshold}"),
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

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 policy.
 *
 * @summary Get policy.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_Get.json
 */
async function policiesGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const policySetName = "{policySetName}";
  const name = "{policyName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.policies.get(resourceGroupName, labName, policySetName, name);
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DevTestLabs.Models;
using Azure.ResourceManager.DevTestLabs;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_Get.json
// this example is just showing the usage of "Policies_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabPolicyResource
string policySetName = "{policySetName}";
DevTestLabPolicyCollection collection = devTestLab.GetDevTestLabPolicies(policySetName);

// invoke the operation
string name = "{policyName}";
NullableResponse<DevTestLabPolicyResource> response = await collection.GetIfExistsAsync(name);
DevTestLabPolicyResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DevTestLabPolicyData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "description": "{policyDescription}",
    "status": "{policyStatus}",
    "factName": "{policyFactName}",
    "factData": "{policyFactData}",
    "threshold": "{policyThreshold}",
    "evaluatorType": "{policyEvaluatorType}",
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}",
  "name": "{labName}",
  "type": "Microsoft.DevTestLab/labs/policySets/policies",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitionen

Name	Beschreibung
CloudError	Fehler aus einer REST-Anforderung.
CloudErrorBody	Textkörper eines Fehlers aus einer REST-Anforderung.
Policy	Eine Richtlinie.
PolicyEvaluatorType	Der Evaluatortyp der Richtlinie (d. h. AllowedValuesPolicy, MaxValuePolicy).
PolicyFactName	Der Name der Richtlinie (z. B. LabVmCount, LabVmSize, MaxVmsAllowedPerLab usw.).
PolicyStatus	Der Status der Richtlinie.

CloudError

Objekt

Fehler aus einer REST-Anforderung.

Name	Typ	Beschreibung
error	CloudErrorBody	Der aufgetretene Cloudfehler

CloudErrorBody

Objekt

Textkörper eines Fehlers aus einer REST-Anforderung.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Innere Fehler.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Policy

Objekt

Eine Richtlinie.

Name	Typ	Beschreibung
id	string	Der Bezeichner der Ressource.
location	string	Der Standort der Ressource.
name	string	Der Name der Ressource.
properties.createdDate	string (date-time)	Das Erstellungsdatum der Richtlinie.
properties.description	string	Die Beschreibung der Richtlinie.
properties.evaluatorType	PolicyEvaluatorType	Der Evaluatortyp der Richtlinie (d. h. AllowedValuesPolicy, MaxValuePolicy).
properties.factData	string	Die Tatsachendaten der Richtlinie.
properties.factName	PolicyFactName	Der Name der Richtlinie (z. B. LabVmCount, LabVmSize, MaxVmsAllowedPerLab usw.).
properties.provisioningState	string	Der Bereitstellungsstatus der Ressource.
properties.status	PolicyStatus	Der Status der Richtlinie.
properties.threshold	string	Der Schwellenwert der Richtlinie (d. h. eine Zahl für MaxValuePolicy und ein JSON-Array mit Werten für AllowedValuesPolicy).
properties.uniqueIdentifier	string	Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
tags	object	Die Tags der Ressource.
type	string	Der Typ der Ressource.

PolicyEvaluatorType

Enumeration

Der Evaluatortyp der Richtlinie (d. h. AllowedValuesPolicy, MaxValuePolicy).

Wert	Beschreibung
AllowedValuesPolicy
MaxValuePolicy

PolicyFactName

Enumeration

Der Name der Richtlinie (z. B. LabVmCount, LabVmSize, MaxVmsAllowedPerLab usw.).

Wert	Beschreibung
EnvironmentTemplate
GalleryImage
LabPremiumVmCount
LabTargetCost
LabVmCount
LabVmSize
ScheduleEditPermission
UserOwnedLabPremiumVmCount
UserOwnedLabVmCount
UserOwnedLabVmCountInSubnet

PolicyStatus

Enumeration

Der Status der Richtlinie.

Wert	Beschreibung
Disabled
Enabled