Azure Native v1.102.0, May 2 23

azure-native.authorization.getPolicyDefinitionAtManagementGroup

Explore with Pulumi AI

This operation retrieves the policy definition in the given management group with the given name. API Version: 2020-09-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>

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]

func LookupPolicyDefinitionAtManagementGroup(ctx *Context, args *LookupPolicyDefinitionAtManagementGroupArgs, opts ...InvokeOption) (*LookupPolicyDefinitionAtManagementGroupResult, error)
func LookupPolicyDefinitionAtManagementGroupOutput(ctx *Context, args *LookupPolicyDefinitionAtManagementGroupOutputArgs, opts ...InvokeOption) LookupPolicyDefinitionAtManagementGroupResultOutput

> 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)
}

public static CompletableFuture<GetPolicyDefinitionAtManagementGroupResult> getPolicyDefinitionAtManagementGroup(GetPolicyDefinitionAtManagementGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:authorization:getPolicyDefinitionAtManagementGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ManagementGroupId string: The ID of the management group.
PolicyDefinitionName string: The name of the policy definition to get.

ManagementGroupId string: The ID of the management group.
PolicyDefinitionName string: The name of the policy definition to get.

managementGroupId String: The ID of the management group.
policyDefinitionName String: The name of the policy definition to get.

managementGroupId string: The ID of the management group.
policyDefinitionName string: The name of the policy definition to get.

management_group_id str: The ID of the management group.
policy_definition_name str: The name of the policy definition to get.

managementGroupId String: The ID of the management group.
policyDefinitionName 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0