Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. authorization
  5. getPolicyDefinitionAtManagementGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.authorization.getPolicyDefinitionAtManagementGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

This operation retrieves the policy definition in the given management group with the given name. Azure REST API version: 2021-06-01.

Other available API versions: 2018-05-01, 2019-06-01, 2023-04-01, 2024-05-01, 2025-01-01.

Using getPolicyDefinitionAtManagementGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPolicyDefinitionAtManagementGroup(args: GetPolicyDefinitionAtManagementGroupArgs, opts?: InvokeOptions): Promise<GetPolicyDefinitionAtManagementGroupResult>
function getPolicyDefinitionAtManagementGroupOutput(args: GetPolicyDefinitionAtManagementGroupOutputArgs, opts?: InvokeOptions): Output<GetPolicyDefinitionAtManagementGroupResult>
Copy
def get_policy_definition_at_management_group(management_group_id: Optional[str] = None,
                                              policy_definition_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetPolicyDefinitionAtManagementGroupResult
def get_policy_definition_at_management_group_output(management_group_id: Optional[pulumi.Input[str]] = None,
                                              policy_definition_name: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetPolicyDefinitionAtManagementGroupResult]
Copy
func LookupPolicyDefinitionAtManagementGroup(ctx *Context, args *LookupPolicyDefinitionAtManagementGroupArgs, opts ...InvokeOption) (*LookupPolicyDefinitionAtManagementGroupResult, error)
func LookupPolicyDefinitionAtManagementGroupOutput(ctx *Context, args *LookupPolicyDefinitionAtManagementGroupOutputArgs, opts ...InvokeOption) LookupPolicyDefinitionAtManagementGroupResultOutput
Copy

> Note: This function is named LookupPolicyDefinitionAtManagementGroup in the Go SDK.

public static class GetPolicyDefinitionAtManagementGroup 
{
    public static Task<GetPolicyDefinitionAtManagementGroupResult> InvokeAsync(GetPolicyDefinitionAtManagementGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyDefinitionAtManagementGroupResult> Invoke(GetPolicyDefinitionAtManagementGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPolicyDefinitionAtManagementGroupResult> getPolicyDefinitionAtManagementGroup(GetPolicyDefinitionAtManagementGroupArgs args, InvokeOptions options)
public static Output<GetPolicyDefinitionAtManagementGroupResult> getPolicyDefinitionAtManagementGroup(GetPolicyDefinitionAtManagementGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:authorization:getPolicyDefinitionAtManagementGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the management group.
PolicyDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the policy definition to get.
ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the management group.
PolicyDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the policy definition to get.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the management group.
policyDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the policy definition to get.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the management group.
policyDefinitionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the policy definition to get.
management_group_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the management group.
policy_definition_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the policy definition to get.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the management group.
policyDefinitionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the policy definition to get.

getPolicyDefinitionAtManagementGroup Result

The following output properties are available:

Id string
The ID of the policy definition.
Name string
The name of the policy definition.
SystemData Pulumi.AzureNative.Authorization.Outputs.SystemDataResponse
The system metadata relating to this resource.
Type string
The type of the resource (Microsoft.Authorization/policyDefinitions).
Description string
The policy definition description.
DisplayName string
The display name of the policy definition.
Metadata object
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Mode string
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
Parameters Dictionary<string, Pulumi.AzureNative.Authorization.Outputs.ParameterDefinitionsValueResponse>
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
PolicyRule object
The policy rule.
PolicyType string
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
Id string
The ID of the policy definition.
Name string
The name of the policy definition.
SystemData SystemDataResponse
The system metadata relating to this resource.
Type string
The type of the resource (Microsoft.Authorization/policyDefinitions).
Description string
The policy definition description.
DisplayName string
The display name of the policy definition.
Metadata interface{}
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
Mode string
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
Parameters map[string]ParameterDefinitionsValueResponse
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
PolicyRule interface{}
The policy rule.
PolicyType string
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
id String
The ID of the policy definition.
name String
The name of the policy definition.
systemData SystemDataResponse
The system metadata relating to this resource.
type String
The type of the resource (Microsoft.Authorization/policyDefinitions).
description String
The policy definition description.
displayName String
The display name of the policy definition.
metadata Object
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
mode String
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
parameters Map<String,ParameterDefinitionsValueResponse>
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
policyRule Object
The policy rule.
policyType String
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
id string
The ID of the policy definition.
name string
The name of the policy definition.
systemData SystemDataResponse
The system metadata relating to this resource.
type string
The type of the resource (Microsoft.Authorization/policyDefinitions).
description string
The policy definition description.
displayName string
The display name of the policy definition.
metadata any
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
mode string
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
parameters {[key: string]: ParameterDefinitionsValueResponse}
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
policyRule any
The policy rule.
policyType string
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
id str
The ID of the policy definition.
name str
The name of the policy definition.
system_data SystemDataResponse
The system metadata relating to this resource.
type str
The type of the resource (Microsoft.Authorization/policyDefinitions).
description str
The policy definition description.
display_name str
The display name of the policy definition.
metadata Any
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
mode str
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
parameters Mapping[str, ParameterDefinitionsValueResponse]
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
policy_rule Any
The policy rule.
policy_type str
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
id String
The ID of the policy definition.
name String
The name of the policy definition.
systemData Property Map
The system metadata relating to this resource.
type String
The type of the resource (Microsoft.Authorization/policyDefinitions).
description String
The policy definition description.
displayName String
The display name of the policy definition.
metadata Any
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
mode String
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
parameters Map<Property Map>
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
policyRule Any
The policy rule.
policyType String
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

Supporting Types

ParameterDefinitionsValueResponse

AllowedValues List<object>
The allowed values for the parameter.
DefaultValue object
The default value for the parameter if no value is provided.
Metadata Pulumi.AzureNative.Authorization.Inputs.ParameterDefinitionsValueResponseMetadata
General metadata for the parameter.
Schema object
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
Type string
The data type of the parameter.
AllowedValues []interface{}
The allowed values for the parameter.
DefaultValue interface{}
The default value for the parameter if no value is provided.
Metadata ParameterDefinitionsValueResponseMetadata
General metadata for the parameter.
Schema interface{}
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
Type string
The data type of the parameter.
allowedValues List<Object>
The allowed values for the parameter.
defaultValue Object
The default value for the parameter if no value is provided.
metadata ParameterDefinitionsValueResponseMetadata
General metadata for the parameter.
schema Object
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
type String
The data type of the parameter.
allowedValues any[]
The allowed values for the parameter.
defaultValue any
The default value for the parameter if no value is provided.
metadata ParameterDefinitionsValueResponseMetadata
General metadata for the parameter.
schema any
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
type string
The data type of the parameter.
allowed_values Sequence[Any]
The allowed values for the parameter.
default_value Any
The default value for the parameter if no value is provided.
metadata ParameterDefinitionsValueResponseMetadata
General metadata for the parameter.
schema Any
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
type str
The data type of the parameter.
allowedValues List<Any>
The allowed values for the parameter.
defaultValue Any
The default value for the parameter if no value is provided.
metadata Property Map
General metadata for the parameter.
schema Any
Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
type String
The data type of the parameter.

ParameterDefinitionsValueResponseMetadata

AssignPermissions bool
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
Description string
The description of the parameter.
DisplayName string
The display name for the parameter.
StrongType string
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
AssignPermissions bool
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
Description string
The description of the parameter.
DisplayName string
The display name for the parameter.
StrongType string
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
assignPermissions Boolean
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
description String
The description of the parameter.
displayName String
The display name for the parameter.
strongType String
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
assignPermissions boolean
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
description string
The description of the parameter.
displayName string
The display name for the parameter.
strongType string
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
assign_permissions bool
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
description str
The description of the parameter.
display_name str
The display name for the parameter.
strong_type str
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
assignPermissions Boolean
Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
description String
The description of the parameter.
displayName String
The display name for the parameter.
strongType String
Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native