1. Packages
  2. Azure Native
  3. API Docs
  4. authorization
  5. getPolicySetDefinition
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.authorization.getPolicySetDefinition

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

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

    Other available API versions: 2019-06-01, 2023-04-01.

    Using getPolicySetDefinition

    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 getPolicySetDefinition(args: GetPolicySetDefinitionArgs, opts?: InvokeOptions): Promise<GetPolicySetDefinitionResult>
    function getPolicySetDefinitionOutput(args: GetPolicySetDefinitionOutputArgs, opts?: InvokeOptions): Output<GetPolicySetDefinitionResult>
    def get_policy_set_definition(policy_set_definition_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetPolicySetDefinitionResult
    def get_policy_set_definition_output(policy_set_definition_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetPolicySetDefinitionResult]
    func LookupPolicySetDefinition(ctx *Context, args *LookupPolicySetDefinitionArgs, opts ...InvokeOption) (*LookupPolicySetDefinitionResult, error)
    func LookupPolicySetDefinitionOutput(ctx *Context, args *LookupPolicySetDefinitionOutputArgs, opts ...InvokeOption) LookupPolicySetDefinitionResultOutput

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

    public static class GetPolicySetDefinition 
    {
        public static Task<GetPolicySetDefinitionResult> InvokeAsync(GetPolicySetDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicySetDefinitionResult> Invoke(GetPolicySetDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicySetDefinitionResult> getPolicySetDefinition(GetPolicySetDefinitionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:authorization:getPolicySetDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PolicySetDefinitionName string
    The name of the policy set definition to get.
    PolicySetDefinitionName string
    The name of the policy set definition to get.
    policySetDefinitionName String
    The name of the policy set definition to get.
    policySetDefinitionName string
    The name of the policy set definition to get.
    policy_set_definition_name str
    The name of the policy set definition to get.
    policySetDefinitionName String
    The name of the policy set definition to get.

    getPolicySetDefinition Result

    The following output properties are available:

    Id string
    The ID of the policy set definition.
    Name string
    The name of the policy set definition.
    PolicyDefinitions List<Pulumi.AzureNative.Authorization.Outputs.PolicyDefinitionReferenceResponse>
    An array of policy definition references.
    SystemData Pulumi.AzureNative.Authorization.Outputs.SystemDataResponse
    The system metadata relating to this resource.
    Type string
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    Description string
    The policy set definition description.
    DisplayName string
    The display name of the policy set definition.
    Metadata object
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    Parameters Dictionary<string, Pulumi.AzureNative.Authorization.Outputs.ParameterDefinitionsValueResponse>
    The policy set definition parameters that can be used in policy definition references.
    PolicyDefinitionGroups List<Pulumi.AzureNative.Authorization.Outputs.PolicyDefinitionGroupResponse>
    The metadata describing groups of policy definition references within the policy set definition.
    PolicyType string
    The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
    Id string
    The ID of the policy set definition.
    Name string
    The name of the policy set definition.
    PolicyDefinitions []PolicyDefinitionReferenceResponse
    An array of policy definition references.
    SystemData SystemDataResponse
    The system metadata relating to this resource.
    Type string
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    Description string
    The policy set definition description.
    DisplayName string
    The display name of the policy set definition.
    Metadata interface{}
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    Parameters map[string]ParameterDefinitionsValueResponse
    The policy set definition parameters that can be used in policy definition references.
    PolicyDefinitionGroups []PolicyDefinitionGroupResponse
    The metadata describing groups of policy definition references within the policy set definition.
    PolicyType string
    The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
    id String
    The ID of the policy set definition.
    name String
    The name of the policy set definition.
    policyDefinitions List<PolicyDefinitionReferenceResponse>
    An array of policy definition references.
    systemData SystemDataResponse
    The system metadata relating to this resource.
    type String
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    description String
    The policy set definition description.
    displayName String
    The display name of the policy set definition.
    metadata Object
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    parameters Map<String,ParameterDefinitionsValueResponse>
    The policy set definition parameters that can be used in policy definition references.
    policyDefinitionGroups List<PolicyDefinitionGroupResponse>
    The metadata describing groups of policy definition references within the policy set definition.
    policyType String
    The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
    id string
    The ID of the policy set definition.
    name string
    The name of the policy set definition.
    policyDefinitions PolicyDefinitionReferenceResponse[]
    An array of policy definition references.
    systemData SystemDataResponse
    The system metadata relating to this resource.
    type string
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    description string
    The policy set definition description.
    displayName string
    The display name of the policy set definition.
    metadata any
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    parameters {[key: string]: ParameterDefinitionsValueResponse}
    The policy set definition parameters that can be used in policy definition references.
    policyDefinitionGroups PolicyDefinitionGroupResponse[]
    The metadata describing groups of policy definition references within the policy set definition.
    policyType string
    The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
    id str
    The ID of the policy set definition.
    name str
    The name of the policy set definition.
    policy_definitions Sequence[PolicyDefinitionReferenceResponse]
    An array of policy definition references.
    system_data SystemDataResponse
    The system metadata relating to this resource.
    type str
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    description str
    The policy set definition description.
    display_name str
    The display name of the policy set definition.
    metadata Any
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    parameters Mapping[str, ParameterDefinitionsValueResponse]
    The policy set definition parameters that can be used in policy definition references.
    policy_definition_groups Sequence[PolicyDefinitionGroupResponse]
    The metadata describing groups of policy definition references within the policy set definition.
    policy_type str
    The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
    id String
    The ID of the policy set definition.
    name String
    The name of the policy set definition.
    policyDefinitions List<Property Map>
    An array of policy definition references.
    systemData Property Map
    The system metadata relating to this resource.
    type String
    The type of the resource (Microsoft.Authorization/policySetDefinitions).
    description String
    The policy set definition description.
    displayName String
    The display name of the policy set definition.
    metadata Any
    The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    parameters Map<Property Map>
    The policy set definition parameters that can be used in policy definition references.
    policyDefinitionGroups List<Property Map>
    The metadata describing groups of policy definition references within the policy set definition.
    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.

    ParameterValuesValueResponse

    Value object
    The value of the parameter.
    Value interface{}
    The value of the parameter.
    value Object
    The value of the parameter.
    value any
    The value of the parameter.
    value Any
    The value of the parameter.
    value Any
    The value of the parameter.

    PolicyDefinitionGroupResponse

    Name string
    The name of the group.
    AdditionalMetadataId string
    A resource ID of a resource that contains additional metadata about the group.
    Category string
    The group's category.
    Description string
    The group's description.
    DisplayName string
    The group's display name.
    Name string
    The name of the group.
    AdditionalMetadataId string
    A resource ID of a resource that contains additional metadata about the group.
    Category string
    The group's category.
    Description string
    The group's description.
    DisplayName string
    The group's display name.
    name String
    The name of the group.
    additionalMetadataId String
    A resource ID of a resource that contains additional metadata about the group.
    category String
    The group's category.
    description String
    The group's description.
    displayName String
    The group's display name.
    name string
    The name of the group.
    additionalMetadataId string
    A resource ID of a resource that contains additional metadata about the group.
    category string
    The group's category.
    description string
    The group's description.
    displayName string
    The group's display name.
    name str
    The name of the group.
    additional_metadata_id str
    A resource ID of a resource that contains additional metadata about the group.
    category str
    The group's category.
    description str
    The group's description.
    display_name str
    The group's display name.
    name String
    The name of the group.
    additionalMetadataId String
    A resource ID of a resource that contains additional metadata about the group.
    category String
    The group's category.
    description String
    The group's description.
    displayName String
    The group's display name.

    PolicyDefinitionReferenceResponse

    PolicyDefinitionId string
    The ID of the policy definition or policy set definition.
    GroupNames List<string>
    The name of the groups that this policy definition reference belongs to.
    Parameters Dictionary<string, Pulumi.AzureNative.Authorization.Inputs.ParameterValuesValueResponse>
    The parameter values for the referenced policy rule. The keys are the parameter names.
    PolicyDefinitionReferenceId string
    A unique id (within the policy set definition) for this policy definition reference.
    PolicyDefinitionId string
    The ID of the policy definition or policy set definition.
    GroupNames []string
    The name of the groups that this policy definition reference belongs to.
    Parameters map[string]ParameterValuesValueResponse
    The parameter values for the referenced policy rule. The keys are the parameter names.
    PolicyDefinitionReferenceId string
    A unique id (within the policy set definition) for this policy definition reference.
    policyDefinitionId String
    The ID of the policy definition or policy set definition.
    groupNames List<String>
    The name of the groups that this policy definition reference belongs to.
    parameters Map<String,ParameterValuesValueResponse>
    The parameter values for the referenced policy rule. The keys are the parameter names.
    policyDefinitionReferenceId String
    A unique id (within the policy set definition) for this policy definition reference.
    policyDefinitionId string
    The ID of the policy definition or policy set definition.
    groupNames string[]
    The name of the groups that this policy definition reference belongs to.
    parameters {[key: string]: ParameterValuesValueResponse}
    The parameter values for the referenced policy rule. The keys are the parameter names.
    policyDefinitionReferenceId string
    A unique id (within the policy set definition) for this policy definition reference.
    policy_definition_id str
    The ID of the policy definition or policy set definition.
    group_names Sequence[str]
    The name of the groups that this policy definition reference belongs to.
    parameters Mapping[str, ParameterValuesValueResponse]
    The parameter values for the referenced policy rule. The keys are the parameter names.
    policy_definition_reference_id str
    A unique id (within the policy set definition) for this policy definition reference.
    policyDefinitionId String
    The ID of the policy definition or policy set definition.
    groupNames List<String>
    The name of the groups that this policy definition reference belongs to.
    parameters Map<Property Map>
    The parameter values for the referenced policy rule. The keys are the parameter names.
    policyDefinitionReferenceId String
    A unique id (within the policy set definition) for this policy definition reference.

    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi