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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.authorization.getPolicySetDefinitionVersionAtManagementGroup
Explore with Pulumi AI
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
This operation retrieves the policy set definition version in the given management group with the given name and version. Azure REST API version: 2023-04-01.
Other available API versions: 2024-05-01.
Using getPolicySetDefinitionVersionAtManagementGroup
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 getPolicySetDefinitionVersionAtManagementGroup(args: GetPolicySetDefinitionVersionAtManagementGroupArgs, opts?: InvokeOptions): Promise<GetPolicySetDefinitionVersionAtManagementGroupResult>
function getPolicySetDefinitionVersionAtManagementGroupOutput(args: GetPolicySetDefinitionVersionAtManagementGroupOutputArgs, opts?: InvokeOptions): Output<GetPolicySetDefinitionVersionAtManagementGroupResult>
def get_policy_set_definition_version_at_management_group(expand: Optional[str] = None,
management_group_name: Optional[str] = None,
policy_definition_version: Optional[str] = None,
policy_set_definition_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicySetDefinitionVersionAtManagementGroupResult
def get_policy_set_definition_version_at_management_group_output(expand: Optional[pulumi.Input[str]] = None,
management_group_name: 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[GetPolicySetDefinitionVersionAtManagementGroupResult]
func LookupPolicySetDefinitionVersionAtManagementGroup(ctx *Context, args *LookupPolicySetDefinitionVersionAtManagementGroupArgs, opts ...InvokeOption) (*LookupPolicySetDefinitionVersionAtManagementGroupResult, error)
func LookupPolicySetDefinitionVersionAtManagementGroupOutput(ctx *Context, args *LookupPolicySetDefinitionVersionAtManagementGroupOutputArgs, opts ...InvokeOption) LookupPolicySetDefinitionVersionAtManagementGroupResultOutput
> Note: This function is named LookupPolicySetDefinitionVersionAtManagementGroup
in the Go SDK.
public static class GetPolicySetDefinitionVersionAtManagementGroup
{
public static Task<GetPolicySetDefinitionVersionAtManagementGroupResult> InvokeAsync(GetPolicySetDefinitionVersionAtManagementGroupArgs args, InvokeOptions? opts = null)
public static Output<GetPolicySetDefinitionVersionAtManagementGroupResult> Invoke(GetPolicySetDefinitionVersionAtManagementGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPolicySetDefinitionVersionAtManagementGroupResult> getPolicySetDefinitionVersionAtManagementGroup(GetPolicySetDefinitionVersionAtManagementGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:authorization:getPolicySetDefinitionVersionAtManagementGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Management
Group stringName - The name of the management group. The name is case insensitive.
- Policy
Definition stringVersion - 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 stringDefinition Name - 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'.
- Management
Group stringName - The name of the management group. The name is case insensitive.
- Policy
Definition stringVersion - 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 stringDefinition Name - 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'.
- management
Group StringName - The name of the management group. The name is case insensitive.
- policy
Definition StringVersion - 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 StringDefinition Name - 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'.
- management
Group stringName - The name of the management group. The name is case insensitive.
- policy
Definition stringVersion - 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 stringDefinition Name - 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'.
- management_
group_ strname - The name of the management group. The name is case insensitive.
- policy_
definition_ strversion - 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_ strdefinition_ name - 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'.
- management
Group StringName - The name of the management group. The name is case insensitive.
- policy
Definition StringVersion - 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 StringDefinition Name - 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'.
getPolicySetDefinitionVersionAtManagementGroup 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.
- Policy
Definitions List<Pulumi.Azure Native. Authorization. Outputs. Policy Definition Reference Response> - An array of policy definition references.
- System
Data Pulumi.Azure Native. Authorization. Outputs. System Data Response - 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.
- Display
Name 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.
Azure Native. Authorization. Outputs. Parameter Definitions Value Response> - The policy set definition parameters that can be used in policy definition references.
- Policy
Definition List<Pulumi.Groups Azure Native. Authorization. Outputs. Policy Definition Group Response> - The metadata describing groups of policy definition references within the policy set definition.
- Policy
Type 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.
- Policy
Definitions []PolicyDefinition Reference Response - An array of policy definition references.
- System
Data SystemData Response - 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.
- Display
Name 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]Parameter
Definitions Value Response - The policy set definition parameters that can be used in policy definition references.
- Policy
Definition []PolicyGroups Definition Group Response - The metadata describing groups of policy definition references within the policy set definition.
- Policy
Type 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.
- policy
Definitions List<PolicyDefinition Reference Response> - An array of policy definition references.
- system
Data SystemData Response - 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.
- display
Name 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,Parameter
Definitions Value Response> - The policy set definition parameters that can be used in policy definition references.
- policy
Definition List<PolicyGroups Definition Group Response> - The metadata describing groups of policy definition references within the policy set definition.
- policy
Type 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.
- policy
Definitions PolicyDefinition Reference Response[] - An array of policy definition references.
- system
Data SystemData Response - 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.
- display
Name 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]: Parameter
Definitions Value Response} - The policy set definition parameters that can be used in policy definition references.
- policy
Definition PolicyGroups Definition Group Response[] - The metadata describing groups of policy definition references within the policy set definition.
- policy
Type 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[PolicyDefinition Reference Response] - An array of policy definition references.
- system_
data SystemData Response - 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, Parameter
Definitions Value Response] - The policy set definition parameters that can be used in policy definition references.
- policy_
definition_ Sequence[Policygroups Definition Group Response] - 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.
- policy
Definitions List<Property Map> - An array of policy definition references.
- system
Data 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.
- display
Name 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.
- policy
Definition List<Property Map>Groups - The metadata describing groups of policy definition references within the policy set definition.
- policy
Type 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
- Allowed
Values List<object> - The allowed values for the parameter.
- Default
Value object - The default value for the parameter if no value is provided.
- Metadata
Pulumi.
Azure Native. Authorization. Inputs. Parameter Definitions Value Response Metadata - 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.
- Allowed
Values []interface{} - The allowed values for the parameter.
- Default
Value interface{} - The default value for the parameter if no value is provided.
- Metadata
Parameter
Definitions Value Response Metadata - 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.
- allowed
Values List<Object> - The allowed values for the parameter.
- default
Value Object - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Response Metadata - 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.
- allowed
Values any[] - The allowed values for the parameter.
- default
Value any - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Response Metadata - 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
Parameter
Definitions Value Response Metadata - 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.
- allowed
Values List<Any> - The allowed values for the parameter.
- default
Value 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
- 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 string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type 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 string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type 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 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.
- display
Name String - The display name for the parameter.
- strong
Type 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 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.
- display
Name string - The display name for the parameter.
- strong
Type 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.
- assign
Permissions 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.
- display
Name String - The display name for the parameter.
- strong
Type 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.
- Additional
Metadata stringId - 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.
- Display
Name string - The group's display name.
- Name string
- The name of the group.
- Additional
Metadata stringId - 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.
- Display
Name string - The group's display name.
- name String
- The name of the group.
- additional
Metadata StringId - 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.
- display
Name String - The group's display name.
- name string
- The name of the group.
- additional
Metadata stringId - 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.
- display
Name string - The group's display name.
- name str
- The name of the group.
- additional_
metadata_ strid - 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.
- additional
Metadata StringId - 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.
- display
Name String - The group's display name.
PolicyDefinitionReferenceResponse
- Effective
Definition stringVersion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- Latest
Definition stringVersion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names List<string> - The name of the groups that this policy definition reference belongs to.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Authorization. Inputs. Parameter Values Value Response> - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- Effective
Definition stringVersion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- Latest
Definition stringVersion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names []string - The name of the groups that this policy definition reference belongs to.
- Parameters
map[string]Parameter
Values Value Response - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- effective
Definition StringVersion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- latest
Definition StringVersion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names List<String> - The name of the groups that this policy definition reference belongs to.
- parameters
Map<String,Parameter
Values Value Response> - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- effective
Definition stringVersion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- latest
Definition stringVersion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- policy
Definition stringId - The ID of the policy definition or policy set definition.
- definition
Version string - The version of the policy definition to use.
- group
Names string[] - The name of the groups that this policy definition reference belongs to.
- parameters
{[key: string]: Parameter
Values Value Response} - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- effective_
definition_ strversion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- latest_
definition_ strversion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- policy_
definition_ strid - 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, Parameter
Values Value Response] - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy_
definition_ strreference_ id - A unique id (within the policy set definition) for this policy definition reference.
- effective
Definition StringVersion - The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
- latest
Definition StringVersion - The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names 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.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi