다음을 통해 공유

Policy Definitions - List

  • 참조
서비스:
Policy
API 버전:
2023-04-01

구독에서 정책 정의를 검색합니다.
이 작업은 지정된 구독에서 지정된 선택적 $filter 일치하는 모든 정책 정의 목록을 검색합니다. $filter 유효한 값은 'atExactScope()', 'policyType -eq {value}' 또는 'category eq '{value}'입니다. $filter 제공되지 않은 경우 필터링되지 않은 목록에는 구독과 연결된 모든 정책 정의가 포함되며, 여기에는 직접 적용되거나 지정된 구독이 포함된 관리 그룹에서 적용되는 정책 정의가 포함됩니다. $filter=atExactScope()가 제공되면 반환된 목록에는 지정된 구독에 있는 모든 정책 정의만 포함됩니다. $filter='policyType -eq {value}'이(가) 제공되면 반환된 목록에는 형식이 {value}에 일치하는 모든 정책 정의만 포함됩니다. 가능한 policyType 값은 NotSpecified, BuiltIn, Custom 및 Static입니다. $filter='category -eq {value}'가 제공되면 반환된 목록에는 범주가 {value}에 일치하는 모든 정책 정의만 포함됩니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01
선택적 매개 변수: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01&$filter={$filter}&$top={$top}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
subscriptionId
 path True

string (uuid)

대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.
$filter
 query

string

작업에 적용할 필터입니다. $filter 유효한 값은 'atExactScope()', 'policyType -eq {value}' 또는 'category eq '{value}'입니다. $filter 제공되지 않으면 필터링이 수행되지 않습니다. $filter=atExactScope()가 제공되면 반환된 목록에는 지정된 범위에 있는 모든 정책 정의만 포함됩니다. $filter='policyType -eq {value}'이(가) 제공되면 반환된 목록에는 형식이 {value}에 일치하는 모든 정책 정의만 포함됩니다. 가능한 policyType 값은 NotSpecified, BuiltIn, Custom 및 Static입니다. $filter='category -eq {value}'가 제공되면 반환된 목록에는 범주가 {value}에 일치하는 모든 정책 정의만 포함됩니다.
$top
 query

integer (int32)

minimum: 1
maximum: 1000

반환할 최대 레코드 수입니다. $top 필터가 제공되지 않으면 500개의 레코드가 반환됩니다.

응답

Name 형식 Description
200 OK

PolicyDefinitionListResult

확인 - 정책 정의의 배열을 반환합니다.
Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

List policy definitions by subscription

샘플 요청

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions?api-version=2023-04-01

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "properties": {
        "mode": "All",
        "displayName": "Allowed storage account SKUs",
        "policyType": "BuiltIn",
        "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.",
        "parameters": {
          "listOfAllowedSKUs": {
            "type": "Array",
            "metadata": {
              "description": "The list of SKUs that can be specified for storage accounts.",
              "displayName": "Allowed SKUs",
              "strongType": "StorageSKUs"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "allOf": [
              {
                "field": "type",
                "equals": "Microsoft.Storage/storageAccounts"
              },
              {
                "not": {
                  "field": "Microsoft.Storage/storageAccounts/sku.name",
                  "in": "[parameters('listOfAllowedSKUs')]"
                }
              }
            ]
          },
          "then": {
            "effect": "Deny"
          }
        }
      },
      "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1"
    },
    {
      "properties": {
        "mode": "All",
        "displayName": "Naming Convention",
        "description": "Force resource names to begin with 'prefix' and end with 'suffix'",
        "metadata": {
          "category": "Naming"
        },
        "parameters": {
          "prefix": {
            "type": "String",
            "metadata": {
              "displayName": "Prefix",
              "description": "Resource name prefix"
            }
          },
          "suffix": {
            "type": "String",
            "metadata": {
              "displayName": "Suffix",
              "description": "Resource name suffix"
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "not": {
              "field": "name",
              "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]"
            }
          },
          "then": {
            "effect": "deny"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "ResourceNaming"
    },
    {
      "properties": {
        "mode": "Microsoft.KeyVault.Data",
        "displayName": "Audit KeyVault certificates that expire within specified number of days",
        "description": "Audit certificates that are stored in Azure Key Vault, that expire within 'X' number of days.",
        "metadata": {
          "category": "KeyVault DataPlane"
        },
        "parameters": {
          "daysToExpire": {
            "type": "Integer",
            "metadata": {
              "displayName": "Days to expire",
              "description": "The number of days for a certificate to expire."
            }
          }
        },
        "version": "1.2.1",
        "versions": [
          "1.2.1",
          "1.0.0"
        ],
        "policyRule": {
          "if": {
            "field": "Microsoft.KeyVault.Data/vaults/certificates/attributes/expiresOn",
            "lessOrEquals": "[addDays(utcNow(), parameters('daysToExpire'))]"
          },
          "then": {
            "effect": "audit"
          }
        },
        "policyType": "Custom"
      },
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/AuditSoonToExpireCerts",
      "type": "Microsoft.Authorization/policyDefinitions",
      "name": "AuditSoonToExpireCerts"
    }
  ]
}

정의

Name Description
CloudError

정책 작업의 오류 응답입니다.
createdByType

리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorResponse

오류 응답
Metadata

매개 변수에 대한 일반 메타데이터입니다.
ParameterDefinitionsValue

정책에 제공할 수 있는 매개 변수의 정의입니다.
parameterType

매개 변수의 데이터 형식입니다.
PolicyDefinition

정책 정의입니다.
PolicyDefinitionListResult

정책 정의 목록입니다.
policyType

정책 정의의 형식입니다. 가능한 값은 NotSpecified, BuiltIn, Custom 및 Static입니다.
systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CloudError

Object

정책 작업의 오류 응답입니다.

Name 형식 Description
error

ErrorResponse

오류 응답
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값 Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorResponse[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

Metadata

Object

매개 변수에 대한 일반 메타데이터입니다.

Name 형식 Description
assignPermissions

boolean

정책 할당 중에 Azure Portal에서 이 매개 변수의 리소스 ID 또는 리소스 범위 값에 대한 역할 할당을 만들도록 true로 설정합니다. 이 속성은 할당 범위 외부에서 권한을 할당하려는 경우에 유용합니다.
description

string

매개 변수에 대한 설명입니다.
displayName

string

매개 변수의 표시 이름입니다.
strongType

string

포털을 통해 정책 정의를 할당할 때 사용됩니다. 사용자가 선택할 수 있는 값의 컨텍스트 인식 목록을 제공합니다.

ParameterDefinitionsValue

Object

정책에 제공할 수 있는 매개 변수의 정의입니다.

Name 형식 Description
allowedValues

object[]

매개 변수에 허용되는 값입니다.
defaultValue

object

값이 제공되지 않은 경우 매개 변수의 기본값입니다.
metadata

Metadata

매개 변수에 대한 일반 메타데이터입니다.
schema

object

자체 정의 JSON 스키마를 사용하여 할당하는 동안 매개 변수 입력의 유효성을 검사합니다. 이 속성은 개체 형식 매개 변수에 대해서만 지원되며 Json.NET 스키마 2019-09 구현을 따릅니다. https://json-schema.org/ 스키마를 사용하고 https://www.jsonschemavalidator.net/초안 스키마를 테스트하는 방법에 대해 자세히 알아볼 수 있습니다.
type

parameterType

매개 변수의 데이터 형식입니다.

parameterType

열거형

매개 변수의 데이터 형식입니다.

값 Description
Array
Boolean
DateTime
Float
Integer
Object
String

PolicyDefinition

Object

정책 정의입니다.

Name 형식 Default value Description
id

string

정책 정의의 ID입니다.
name

string

정책 정의의 이름입니다.
properties.description

string

정책 정의 설명입니다.
properties.displayName

string

정책 정의의 표시 이름입니다.
properties.metadata

object

정책 정의 메타데이터입니다. 메타데이터는 열려 있는 종료된 개체이며 일반적으로 키 값 쌍의 컬렉션입니다.
properties.mode

string

Indexed

정책 정의 모드입니다. 일부 예는 All, Indexed, Microsoft.KeyVault.Data입니다.
properties.parameters

<string,  ParameterDefinitionsValue>

정책 규칙에 사용되는 매개 변수에 대한 매개 변수 정의입니다. 키는 매개 변수 이름입니다.
properties.policyRule

object

정책 규칙입니다.
properties.policyType

policyType

정책 정의의 형식입니다. 가능한 값은 NotSpecified, BuiltIn, Custom 및 Static입니다.
properties.version

string

#.#.# 형식의 정책 정의 버전입니다.
properties.versions

string[]

이 정책 정의에 사용할 수 있는 버전 목록입니다.
systemData

systemData

이 리소스와 관련된 시스템 메타데이터입니다.
type

string

리소스의 형식입니다(Microsoft.Authorization/policyDefinitions).

PolicyDefinitionListResult

Object

정책 정의 목록입니다.

Name 형식 Description
nextLink

string

다음 결과 집합을 가져오는 데 사용할 URL입니다.
value

PolicyDefinition[]

정책 정의의 배열입니다.

policyType

열거형

정책 정의의 형식입니다. 가능한 값은 NotSpecified, BuiltIn, Custom 및 Static입니다.

값 Description
BuiltIn
Custom
NotSpecified
Static

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string (date-time)

리소스 만들기의 타임스탬프(UTC)입니다.
createdBy

string

리소스를 만든 ID입니다.
createdByType

createdByType

리소스를 만든 ID의 형식입니다.
lastModifiedAt

string (date-time)

리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType

createdByType

리소스를 마지막으로 수정한 ID의 형식입니다.