Перечисление политик в заданном наборе политик.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies?api-version=2018-09-15
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15
Параметры URI
Имя |
В |
Обязательно |
Тип |
Описание |
labName
|
path |
True
|
string
|
Имя лаборатории.
|
policySetName
|
path |
True
|
string
|
Имя набора политик.
|
resourceGroupName
|
path |
True
|
string
|
Имя группы ресурсов.
|
subscriptionId
|
path |
True
|
string
|
Идентификатор подписки.
|
api-version
|
query |
True
|
string
|
Версия API клиента.
|
$expand
|
query |
|
string
|
Укажите запрос $expand. Пример: 'properties($select=description)'
|
$filter
|
query |
|
string
|
Фильтр, применяемый к операции. Пример: '$filter=contains(name;'myName')
|
$orderby
|
query |
|
string
|
Упорядоченное выражение для результатов с использованием нотации OData. Пример: "$orderby=name desc"
|
$top
|
query |
|
integer
int32
|
Максимальное количество ресурсов, возвращаемых операцией. Пример: "$top=10"
|
Ответы
Безопасность
azure_auth
Неявное предоставление OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя |
Описание |
user_impersonation
|
Доступ к Microsoft Azure
|
Примеры
Policies_List
Sample Request
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies?api-version=2018-09-15
/** Samples for Policies List. */
public final class Main {
/*
* x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_List.json
*/
/**
* Sample code: Policies_List.
*
* @param manager Entry point to DevTestLabsManager.
*/
public static void policiesList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
manager
.policies()
.list(
"resourceGroupName",
"{labName}",
"{policySetName}",
null,
null,
null,
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-devtestlabs
# USAGE
python policies_list.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.list(
resource_group_name="resourceGroupName",
lab_name="{labName}",
policy_set_name="{policySetName}",
)
for item in response:
print(item)
# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_List.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
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_List.json
func ExamplePoliciesClient_NewListPager() {
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)
}
pager := clientFactory.NewPoliciesClient().NewListPager("resourceGroupName", "{labName}", "{policySetName}", &armdevtestlabs.PoliciesClientListOptions{Expand: nil,
Filter: nil,
Top: nil,
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.PolicyList = armdevtestlabs.PolicyList{
// Value: []*armdevtestlabs.Policy{
// {
// Name: to.Ptr("{labName}"),
// Type: to.Ptr("Microsoft.DevTestLab/labs/policySets/policies"),
// ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{policyName}"),
// Location: to.Ptr("{location}"),
// Tags: map[string]*string{
// "tagName1": to.Ptr("tagValue1"),
// },
// 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
const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to List policies in a given policy set.
*
* @summary List policies in a given policy set.
* x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_List.json
*/
async function policiesList() {
const subscriptionId = "{subscriptionId}";
const resourceGroupName = "resourceGroupName";
const labName = "{labName}";
const policySetName = "{policySetName}";
const credential = new DefaultAzureCredential();
const client = new DevTestLabsClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.policies.list(resourceGroupName, labName, policySetName)) {
resArray.push(item);
}
console.log(resArray);
}
policiesList().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
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;
// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Policies_List.json
// this example is just showing the usage of "Policies_List" 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 and iterate over the result
await foreach (DevTestLabPolicyResource item in collection.GetAllAsync())
{
// the variable item 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 = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"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"
}
}
]
}
Определения
CloudError
Ошибка из запроса REST.
CloudErrorBody
Текст ошибки из запроса REST.
Имя |
Тип |
Описание |
code
|
string
|
Код ошибки.
|
details
|
CloudErrorBody[]
|
Внутренние ошибки.
|
message
|
string
|
Сообщение об ошибке.
|
target
|
string
|
Целевой объект ошибки.
|
Policy
Политика.
Имя |
Тип |
Описание |
id
|
string
|
Идентификатор ресурса.
|
location
|
string
|
Расположение ресурса.
|
name
|
string
|
Имя ресурса.
|
properties.createdDate
|
string
|
Дата создания политики.
|
properties.description
|
string
|
Описание политики.
|
properties.evaluatorType
|
PolicyEvaluatorType
|
Тип оценщика политики (т. е. AllowedValuesPolicy, MaxValuePolicy).
|
properties.factData
|
string
|
Фактические данные политики.
|
properties.factName
|
PolicyFactName
|
Фактическое имя политики (например, LabVmCount, LabVmSize, MaxVmsAllowedPerLab и т. д.
|
properties.provisioningState
|
string
|
Состояние подготовки ресурса.
|
properties.status
|
PolicyStatus
|
Состояние политики.
|
properties.threshold
|
string
|
Порог политики (т. е. число для MaxValuePolicy и массив значений JSON для AllowedValuesPolicy).
|
properties.uniqueIdentifier
|
string
|
Уникальный неизменяемый идентификатор ресурса (Guid).
|
tags
|
object
|
Теги ресурса.
|
type
|
string
|
Тип ресурса.
|
PolicyEvaluatorType
Тип оценщика политики (т. е. AllowedValuesPolicy, MaxValuePolicy).
Имя |
Тип |
Описание |
AllowedValuesPolicy
|
string
|
|
MaxValuePolicy
|
string
|
|
PolicyFactName
Фактическое имя политики (например, LabVmCount, LabVmSize, MaxVmsAllowedPerLab и т. д.
Имя |
Тип |
Описание |
EnvironmentTemplate
|
string
|
|
GalleryImage
|
string
|
|
LabPremiumVmCount
|
string
|
|
LabTargetCost
|
string
|
|
LabVmCount
|
string
|
|
LabVmSize
|
string
|
|
ScheduleEditPermission
|
string
|
|
UserOwnedLabPremiumVmCount
|
string
|
|
UserOwnedLabVmCount
|
string
|
|
UserOwnedLabVmCountInSubnet
|
string
|
|
PolicyList
Ответ операции со списком.
Имя |
Тип |
Описание |
nextLink
|
string
|
Ссылка для следующего набора результатов.
|
value
|
Policy[]
|
Результаты операции со списком.
|
PolicyStatus
Состояние политики.
Имя |
Тип |
Описание |
Disabled
|
string
|
|
Enabled
|
string
|
|