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}?api-version=2018-09-15&$expand={$expand}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	labs
name	path	True	string	Der Name der Police
policySetName	path	True	string	Richtliniensätze
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Geben Sie die $expand Abfrage an. Beispiel: "properties($select=description)"

Antworten

Name	Typ	Beschreibung
200 OK	Policy	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
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.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Policy

Objekt

Eine Richtlinie.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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).
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Die Tags der Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

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
UserOwnedLabVmCount
UserOwnedLabPremiumVmCount
LabVmCount
LabPremiumVmCount
LabVmSize
GalleryImage
UserOwnedLabVmCountInSubnet
LabTargetCost
EnvironmentTemplate
ScheduleEditPermission

PolicyStatus

Enumeration

Der Status der Richtlinie.

Wert	Beschreibung
Enabled
Disabled

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.