Policies - List

Serviço:

Dev Test Labs

Versão da API:

2018-09-15

Listar políticas em um determinado conjunto de políticas.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	Laboratórios
policySetName	path	True	string	conjuntos de políticas
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($select=description)'
$filter	query		string	O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')
$orderby	query		string	A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'
$top	query		integer (int32)	O número máximo de recursos a serem retornados da operação. Exemplo: '$top=10'

Respostas

Nome	Tipo	Description
200 OK	PolicyList	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Policies_List

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "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"
      }
    }
  ]
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Policy	Uma política.
PolicyEvaluatorType	O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).
PolicyFactName	O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.
PolicyList	A resposta de uma operação de lista.
PolicyStatus	O status da política.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Policy

Objeto

Uma política.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização do recurso.
name	string	O nome do recurso
properties.createdDate	string (date-time)	A data de criação da política.
properties.description	string	A descrição da política.
properties.evaluatorType	PolicyEvaluatorType	O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).
properties.factData	string	Os dados de fato da política.
properties.factName	PolicyFactName	O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.
properties.provisioningState	string	O status de provisionamento do recurso.
properties.status	PolicyStatus	O status da política.
properties.threshold	string	O limite da política (ou seja, um número para MaxValuePolicy e uma matriz JSON de valores para AllowedValuesPolicy).
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	As marcas do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PolicyEvaluatorType

Enumeração

O tipo de avaliador da política (ou seja, AllowedValuesPolicy, MaxValuePolicy).

Valor	Description
AllowedValuesPolicy
MaxValuePolicy

PolicyFactName

Enumeração

O nome do fato da política (por exemplo, LabVmCount, LabVmSize, MaxVmsAllowedPerLab etc.

Valor	Description
UserOwnedLabVmCount
UserOwnedLabPremiumVmCount
LabVmCount
LabPremiumVmCount
LabVmSize
GalleryImage
UserOwnedLabVmCountInSubnet
LabTargetCost
EnvironmentTemplate
ScheduleEditPermission

PolicyList

Objeto

A resposta de uma operação de lista.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Policy[]	Os itens de política nesta página

PolicyStatus

Enumeração

O status da política.

Valor	Description
Enabled
Disabled

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.