Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.authorization.getPolicySetDefinitionVersion

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getPolicySetDefinitionVersion

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.

TypeScript
Python
Go
C#
Java
YAML

function getPolicySetDefinitionVersion(args: GetPolicySetDefinitionVersionArgs, opts?: InvokeOptions): Promise<GetPolicySetDefinitionVersionResult>
function getPolicySetDefinitionVersionOutput(args: GetPolicySetDefinitionVersionOutputArgs, opts?: InvokeOptions): Output<GetPolicySetDefinitionVersionResult>

def get_policy_set_definition_version(expand: Optional[str] = None,
                                      policy_definition_version: Optional[str] = None,
                                      policy_set_definition_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetPolicySetDefinitionVersionResult
def get_policy_set_definition_version_output(expand: Optional[pulumi.Input[str]] = None,
                                      policy_definition_version: Optional[pulumi.Input[str]] = None,
                                      policy_set_definition_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetPolicySetDefinitionVersionResult]

func LookupPolicySetDefinitionVersion(ctx *Context, args *LookupPolicySetDefinitionVersionArgs, opts ...InvokeOption) (*LookupPolicySetDefinitionVersionResult, error)
func LookupPolicySetDefinitionVersionOutput(ctx *Context, args *LookupPolicySetDefinitionVersionOutputArgs, opts ...InvokeOption) LookupPolicySetDefinitionVersionResultOutput

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

public static class GetPolicySetDefinitionVersion 
{
    public static Task<GetPolicySetDefinitionVersionResult> InvokeAsync(GetPolicySetDefinitionVersionArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicySetDefinitionVersionResult> Invoke(GetPolicySetDefinitionVersionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPolicySetDefinitionVersionResult> getPolicySetDefinitionVersion(GetPolicySetDefinitionVersionArgs args, InvokeOptions options)
public static Output<GetPolicySetDefinitionVersionResult> getPolicySetDefinitionVersion(GetPolicySetDefinitionVersionArgs args, InvokeOptions options)

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

The following arguments are supported:

PolicyDefinitionVersion string: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
PolicySetDefinitionName string: The name of the policy set definition.
Expand string: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

PolicyDefinitionVersion string: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
PolicySetDefinitionName string: The name of the policy set definition.
Expand string: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

policyDefinitionVersion String: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
policySetDefinitionName String: The name of the policy set definition.
expand String: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

policyDefinitionVersion string: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
policySetDefinitionName string: The name of the policy set definition.
expand string: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

policy_definition_version str: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
policy_set_definition_name str: The name of the policy set definition.
expand str: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

policyDefinitionVersion String: The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
policySetDefinitionName String: The name of the policy set definition.
expand String: Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.

getPolicySetDefinitionVersion Result

The following output properties are available:

Id string: The ID of the policy set definition version.
Name string: The name of the policy set definition version.
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/versions).
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.
Version string: The policy set definition version in #.#.# format.

Id string: The ID of the policy set definition version.
Name string: The name of the policy set definition version.
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/versions).
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.
Version string: The policy set definition version in #.#.# format.

id String: The ID of the policy set definition version.
name String: The name of the policy set definition version.
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/versions).
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.
version String: The policy set definition version in #.#.# format.

id string: The ID of the policy set definition version.
name string: The name of the policy set definition version.
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/versions).
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.
version string: The policy set definition version in #.#.# format.

id str: The ID of the policy set definition version.
name str: The name of the policy set definition version.
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/versions).
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.
version str: The policy set definition version in #.#.# format.

id String: The ID of the policy set definition version.
name String: The name of the policy set definition version.
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/versions).
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.
version String: The policy set definition version in #.#.# format.

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

EffectiveDefinitionVersion string: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
LatestDefinitionVersion string: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
PolicyDefinitionId string: The ID of the policy definition or policy set definition.
DefinitionVersion string: The version of the policy definition to use.
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.

EffectiveDefinitionVersion string: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
LatestDefinitionVersion string: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
PolicyDefinitionId string: The ID of the policy definition or policy set definition.
DefinitionVersion string: The version of the policy definition to use.
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.

effectiveDefinitionVersion String: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
latestDefinitionVersion String: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
policyDefinitionId String: The ID of the policy definition or policy set definition.
definitionVersion String: The version of the policy definition to use.
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.

effectiveDefinitionVersion string: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
latestDefinitionVersion string: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
policyDefinitionId string: The ID of the policy definition or policy set definition.
definitionVersion string: The version of the policy definition to use.
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.

effective_definition_version str: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
latest_definition_version str: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
policy_definition_id str: The ID of the policy definition or policy set definition.
definition_version str: The version of the policy definition to use.
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.

effectiveDefinitionVersion String: The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
latestDefinitionVersion String: The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
policyDefinitionId String: The ID of the policy definition or policy set definition.
definitionVersion String: The version of the policy definition to use.
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-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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.authorization.getPolicySetDefinitionVersion

On this page

On this page

Using getPolicySetDefinitionVersion

getPolicySetDefinitionVersion Result

Supporting Types

ParameterDefinitionsValueResponse

ParameterDefinitionsValueResponseMetadata

ParameterValuesValueResponse

PolicyDefinitionGroupResponse

PolicyDefinitionReferenceResponse

SystemDataResponse

Package Details

On this page

On this page