Policy Set Definitions - Get At Management Group

捕獲原則集合定義。
這項作業會在指定的管理群組中,以指定的名稱抓取原則集合定義。

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}?api-version=2020-09-01

URI 參數

Name In Required Type Description
managementGroupId
path True
  • string

管理群組的識別碼。

policySetDefinitionName
path True
  • string

要取得的原則集定義名稱。

api-version
query True
  • string

用於操作的 API 版本。

回應

Name Type Description
200 OK

確定-傳回原則集定義的相關資訊。

Other Status Codes

描述作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

Retrieve a policy set definition at management group level

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement?api-version=2020-09-01

Sample Response

{
  "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "name": "CostManagement",
  "properties": {
    "displayName": "Cost Management",
    "description": "Policies to enforce low cost storage SKUs",
    "metadata": {
      "category": "Cost Management"
    },
    "policyDefinitions": [
      {
        "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
        "policyDefinitionReferenceId": "Limit_Skus",
        "parameters": {
          "listOfAllowedSKUs": {
            "value": [
              "Standard_GRS",
              "Standard_LRS"
            ]
          }
        }
      },
      {
        "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
        "policyDefinitionReferenceId": "Resource_Naming",
        "parameters": {
          "prefix": {
            "value": "DeptA"
          },
          "suffix": {
            "value": "-LC"
          }
        }
      }
    ]
  }
}

定義

CloudError

原則操作的錯誤回應。

ErrorAdditionalInfo

資源管理錯誤的其他資訊。

ErrorResponse

錯誤回應

Metadata

參數的一般中繼資料。

ParameterDefinitionsValue

可提供給原則之參數的定義。

parameterType

參數的資料類型。

ParameterValuesValue

參數的值。

PolicyDefinitionGroup

原則定義群組。

PolicyDefinitionReference

原則定義參考。

PolicySetDefinition

原則集合定義。

policyType

原則定義的類型。 可能的值為 NotSpecified、內建、自訂和靜態。

CloudError

原則操作的錯誤回應。

Name Type Description
error

錯誤回應
所有 Azure Resource Manager Api 的常見錯誤回應,可傳回失敗作業的錯誤詳細資料。 (這也會遵循 OData 錯誤回應格式。 )

ErrorAdditionalInfo

資源管理錯誤的其他資訊。

Name Type Description
info
  • object

其他資訊。

type
  • string

其他資訊類型。

ErrorResponse

錯誤回應

Name Type Description
additionalInfo

錯誤的其他資訊。

code
  • string

錯誤碼。

details

錯誤詳細資料。

message
  • string

錯誤訊息。

target
  • string

錯誤目標。

Metadata

參數的一般中繼資料。

Name Type Description
assignPermissions
  • boolean

設定為 true,讓 Azure 入口網站在原則指派期間,于此參數的資源識別碼或資源範圍值上建立角色指派。 如果您想要在指派範圍之外指派權限,此屬性會很有用。

description
  • string

參數的描述。

displayName
  • string

參數的顯示名稱。

strongType
  • string

在透過入口網站指派原則定義時使用。 提供可供使用者選擇之值的內容感知清單。

ParameterDefinitionsValue

可提供給原則之參數的定義。

Name Type Description
allowedValues
  • object[]

允許的參數值。

defaultValue
  • object

如果未提供任何值,則為參數的預設值。

metadata

參數的一般中繼資料。

type

參數的資料類型。

parameterType

參數的資料類型。

Name Type Description
Array
  • string
Boolean
  • string
DateTime
  • string
Float
  • string
Integer
  • string
Object
  • string
String
  • string

ParameterValuesValue

參數的值。

Name Type Description
value
  • object

參數的值。

PolicyDefinitionGroup

原則定義群組。

Name Type Description
additionalMetadataId
  • string

資源的資源識別碼,其中包含有關群組的其他中繼資料。

category
  • string

群組的類別。

description
  • string

群組的描述。

displayName
  • string

群組的顯示名稱。

name
  • string

群組的名稱。

PolicyDefinitionReference

原則定義參考。

Name Type Description
groupNames
  • string[]

此原則定義參考所屬群組的名稱。

parameters

參考之原則規則的參數值。 這些索引鍵是參數名稱。

policyDefinitionId
  • string

原則定義或原則集定義的識別碼。

policyDefinitionReferenceId
  • string

(此原則定義參考的原則集定義) 內的唯一識別碼。

PolicySetDefinition

原則集合定義。

Name Type Description
id
  • string

原則集定義的識別碼。

name
  • string

原則集定義的名稱。

properties.description
  • string

原則集定義描述。

properties.displayName
  • string

原則集定義的顯示名稱。

properties.metadata
  • object

原則集定義中繼資料。 中繼資料是開放式結束物件,通常是索引鍵值組的集合。

properties.parameters

可以在原則定義參考中使用的原則集定義參數。

properties.policyDefinitionGroups

描述原則集定義內原則定義參考群組的中繼資料。

properties.policyDefinitions

原則定義參考的陣列。

properties.policyType

原則定義的類型。 可能的值為 NotSpecified、內建、自訂和靜態。

type
  • string

(Microsoft 授權/policySetDefinitions) 的資源類型。

policyType

原則定義的類型。 可能的值為 NotSpecified、內建、自訂和靜態。

Name Type Description
BuiltIn
  • string
Custom
  • string
NotSpecified
  • string
Static
  • string