Documentation
¶
Index ¶
- type Assignment
- type AssignmentArgs
- type AssignmentIdentity
- type AssignmentIdentityArgs
- func (AssignmentIdentityArgs) ElementType() reflect.Type
- func (i AssignmentIdentityArgs) ToAssignmentIdentityOutput() AssignmentIdentityOutput
- func (i AssignmentIdentityArgs) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput
- func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
- func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
- type AssignmentIdentityInput
- type AssignmentIdentityOutput
- func (AssignmentIdentityOutput) ElementType() reflect.Type
- func (o AssignmentIdentityOutput) PrincipalId() pulumi.StringPtrOutput
- func (o AssignmentIdentityOutput) TenantId() pulumi.StringPtrOutput
- func (o AssignmentIdentityOutput) ToAssignmentIdentityOutput() AssignmentIdentityOutput
- func (o AssignmentIdentityOutput) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput
- func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
- func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
- func (o AssignmentIdentityOutput) Type() pulumi.StringPtrOutput
- type AssignmentIdentityPtrInput
- type AssignmentIdentityPtrOutput
- func (o AssignmentIdentityPtrOutput) Elem() AssignmentIdentityOutput
- func (AssignmentIdentityPtrOutput) ElementType() reflect.Type
- func (o AssignmentIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput
- func (o AssignmentIdentityPtrOutput) TenantId() pulumi.StringPtrOutput
- func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
- func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
- func (o AssignmentIdentityPtrOutput) Type() pulumi.StringPtrOutput
- type AssignmentState
- type Definition
- type DefinitionArgs
- type DefinitionState
- type GetPolicyDefintionArgs
- type GetPolicyDefintionResult
- type LookupPolicySetDefinitionArgs
- type LookupPolicySetDefinitionResult
- type PolicySetDefinition
- type PolicySetDefinitionArgs
- type PolicySetDefinitionState
- type Remediation
- type RemediationArgs
- type RemediationState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Assignment ¶
type Assignment struct { pulumi.CustomResourceState // A description to use for this Policy Assignment. Changing this forces a new resource to be created. Description pulumi.StringPtrOutput `pulumi:"description"` // A friendly display name to use for this Policy Assignment. Changing this forces a new resource to be created. DisplayName pulumi.StringPtrOutput `pulumi:"displayName"` // An `identity` block. Identity AssignmentIdentityOutput `pulumi:"identity"` // The Azure location where this policy assignment should exist. This is required when an Identity is assigned. Changing this forces a new resource to be created. Location pulumi.StringOutput `pulumi:"location"` // The name of the Policy Assignment. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // A list of the Policy Assignment's excluded scopes. The list must contain Resource IDs (such as Subscriptions e.g. `/subscriptions/00000000-0000-0000-000000000000` or Resource Groups e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). NotScopes pulumi.StringArrayOutput `pulumi:"notScopes"` // Parameters for the policy definition. This field is a JSON object that maps to the Parameters field from the Policy Definition. Changing this forces a new resource to be created. Parameters pulumi.StringPtrOutput `pulumi:"parameters"` // The ID of the Policy Definition to be applied at the specified Scope. PolicyDefinitionId pulumi.StringOutput `pulumi:"policyDefinitionId"` // The Scope at which the Policy Assignment should be applied, which must be a Resource ID (such as Subscription e.g. `/subscriptions/00000000-0000-0000-000000000000` or a Resource Group e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). Changing this forces a new resource to be created. Scope pulumi.StringOutput `pulumi:"scope"` }
Configures the specified Policy Definition at the specified Scope. Also, Policy Set Definitions are supported.
func GetAssignment ¶
func GetAssignment(ctx *pulumi.Context, name string, id pulumi.IDInput, state *AssignmentState, opts ...pulumi.ResourceOption) (*Assignment, error)
GetAssignment gets an existing Assignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAssignment ¶
func NewAssignment(ctx *pulumi.Context, name string, args *AssignmentArgs, opts ...pulumi.ResourceOption) (*Assignment, error)
NewAssignment registers a new resource with the given unique name, arguments, and options.
type AssignmentArgs ¶
type AssignmentArgs struct { // A description to use for this Policy Assignment. Changing this forces a new resource to be created. Description pulumi.StringPtrInput // A friendly display name to use for this Policy Assignment. Changing this forces a new resource to be created. DisplayName pulumi.StringPtrInput // An `identity` block. Identity AssignmentIdentityPtrInput // The Azure location where this policy assignment should exist. This is required when an Identity is assigned. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // The name of the Policy Assignment. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // A list of the Policy Assignment's excluded scopes. The list must contain Resource IDs (such as Subscriptions e.g. `/subscriptions/00000000-0000-0000-000000000000` or Resource Groups e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). NotScopes pulumi.StringArrayInput // Parameters for the policy definition. This field is a JSON object that maps to the Parameters field from the Policy Definition. Changing this forces a new resource to be created. Parameters pulumi.StringPtrInput // The ID of the Policy Definition to be applied at the specified Scope. PolicyDefinitionId pulumi.StringInput // The Scope at which the Policy Assignment should be applied, which must be a Resource ID (such as Subscription e.g. `/subscriptions/00000000-0000-0000-000000000000` or a Resource Group e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). Changing this forces a new resource to be created. Scope pulumi.StringInput }
The set of arguments for constructing a Assignment resource.
func (AssignmentArgs) ElementType ¶
func (AssignmentArgs) ElementType() reflect.Type
type AssignmentIdentity ¶
type AssignmentIdentity struct { // The Principal ID of this Policy Assignment if `type` is `SystemAssigned`. PrincipalId *string `pulumi:"principalId"` // The Tenant ID of this Policy Assignment if `type` is `SystemAssigned`. TenantId *string `pulumi:"tenantId"` // The Managed Service Identity Type of this Policy Assignment. Possible values are `SystemAssigned` (where Azure will generate a Service Principal for you), or `None` (no use of a Managed Service Identity). Type *string `pulumi:"type"` }
type AssignmentIdentityArgs ¶
type AssignmentIdentityArgs struct { // The Principal ID of this Policy Assignment if `type` is `SystemAssigned`. PrincipalId pulumi.StringPtrInput `pulumi:"principalId"` // The Tenant ID of this Policy Assignment if `type` is `SystemAssigned`. TenantId pulumi.StringPtrInput `pulumi:"tenantId"` // The Managed Service Identity Type of this Policy Assignment. Possible values are `SystemAssigned` (where Azure will generate a Service Principal for you), or `None` (no use of a Managed Service Identity). Type pulumi.StringPtrInput `pulumi:"type"` }
func (AssignmentIdentityArgs) ElementType ¶
func (AssignmentIdentityArgs) ElementType() reflect.Type
func (AssignmentIdentityArgs) ToAssignmentIdentityOutput ¶
func (i AssignmentIdentityArgs) ToAssignmentIdentityOutput() AssignmentIdentityOutput
func (AssignmentIdentityArgs) ToAssignmentIdentityOutputWithContext ¶
func (i AssignmentIdentityArgs) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput
func (AssignmentIdentityArgs) ToAssignmentIdentityPtrOutput ¶
func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
func (AssignmentIdentityArgs) ToAssignmentIdentityPtrOutputWithContext ¶
func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
type AssignmentIdentityInput ¶
type AssignmentIdentityInput interface { pulumi.Input ToAssignmentIdentityOutput() AssignmentIdentityOutput ToAssignmentIdentityOutputWithContext(context.Context) AssignmentIdentityOutput }
AssignmentIdentityInput is an input type that accepts AssignmentIdentityArgs and AssignmentIdentityOutput values. You can construct a concrete instance of `AssignmentIdentityInput` via:
AssignmentIdentityArgs{...}
type AssignmentIdentityOutput ¶
type AssignmentIdentityOutput struct{ *pulumi.OutputState }
func (AssignmentIdentityOutput) ElementType ¶
func (AssignmentIdentityOutput) ElementType() reflect.Type
func (AssignmentIdentityOutput) PrincipalId ¶
func (o AssignmentIdentityOutput) PrincipalId() pulumi.StringPtrOutput
The Principal ID of this Policy Assignment if `type` is `SystemAssigned`.
func (AssignmentIdentityOutput) TenantId ¶
func (o AssignmentIdentityOutput) TenantId() pulumi.StringPtrOutput
The Tenant ID of this Policy Assignment if `type` is `SystemAssigned`.
func (AssignmentIdentityOutput) ToAssignmentIdentityOutput ¶
func (o AssignmentIdentityOutput) ToAssignmentIdentityOutput() AssignmentIdentityOutput
func (AssignmentIdentityOutput) ToAssignmentIdentityOutputWithContext ¶
func (o AssignmentIdentityOutput) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput
func (AssignmentIdentityOutput) ToAssignmentIdentityPtrOutput ¶
func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
func (AssignmentIdentityOutput) ToAssignmentIdentityPtrOutputWithContext ¶
func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
func (AssignmentIdentityOutput) Type ¶
func (o AssignmentIdentityOutput) Type() pulumi.StringPtrOutput
The Managed Service Identity Type of this Policy Assignment. Possible values are `SystemAssigned` (where Azure will generate a Service Principal for you), or `None` (no use of a Managed Service Identity).
type AssignmentIdentityPtrInput ¶
type AssignmentIdentityPtrInput interface { pulumi.Input ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput ToAssignmentIdentityPtrOutputWithContext(context.Context) AssignmentIdentityPtrOutput }
AssignmentIdentityPtrInput is an input type that accepts AssignmentIdentityArgs, AssignmentIdentityPtr and AssignmentIdentityPtrOutput values. You can construct a concrete instance of `AssignmentIdentityPtrInput` via:
AssignmentIdentityArgs{...} or: nil
func AssignmentIdentityPtr ¶
func AssignmentIdentityPtr(v *AssignmentIdentityArgs) AssignmentIdentityPtrInput
type AssignmentIdentityPtrOutput ¶
type AssignmentIdentityPtrOutput struct{ *pulumi.OutputState }
func (AssignmentIdentityPtrOutput) Elem ¶
func (o AssignmentIdentityPtrOutput) Elem() AssignmentIdentityOutput
func (AssignmentIdentityPtrOutput) ElementType ¶
func (AssignmentIdentityPtrOutput) ElementType() reflect.Type
func (AssignmentIdentityPtrOutput) PrincipalId ¶
func (o AssignmentIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput
The Principal ID of this Policy Assignment if `type` is `SystemAssigned`.
func (AssignmentIdentityPtrOutput) TenantId ¶
func (o AssignmentIdentityPtrOutput) TenantId() pulumi.StringPtrOutput
The Tenant ID of this Policy Assignment if `type` is `SystemAssigned`.
func (AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutput ¶
func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
func (AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutputWithContext ¶
func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput
func (AssignmentIdentityPtrOutput) Type ¶
func (o AssignmentIdentityPtrOutput) Type() pulumi.StringPtrOutput
The Managed Service Identity Type of this Policy Assignment. Possible values are `SystemAssigned` (where Azure will generate a Service Principal for you), or `None` (no use of a Managed Service Identity).
type AssignmentState ¶
type AssignmentState struct { // A description to use for this Policy Assignment. Changing this forces a new resource to be created. Description pulumi.StringPtrInput // A friendly display name to use for this Policy Assignment. Changing this forces a new resource to be created. DisplayName pulumi.StringPtrInput // An `identity` block. Identity AssignmentIdentityPtrInput // The Azure location where this policy assignment should exist. This is required when an Identity is assigned. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // The name of the Policy Assignment. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // A list of the Policy Assignment's excluded scopes. The list must contain Resource IDs (such as Subscriptions e.g. `/subscriptions/00000000-0000-0000-000000000000` or Resource Groups e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). NotScopes pulumi.StringArrayInput // Parameters for the policy definition. This field is a JSON object that maps to the Parameters field from the Policy Definition. Changing this forces a new resource to be created. Parameters pulumi.StringPtrInput // The ID of the Policy Definition to be applied at the specified Scope. PolicyDefinitionId pulumi.StringPtrInput // The Scope at which the Policy Assignment should be applied, which must be a Resource ID (such as Subscription e.g. `/subscriptions/00000000-0000-0000-000000000000` or a Resource Group e.g.`/subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup`). Changing this forces a new resource to be created. Scope pulumi.StringPtrInput }
func (AssignmentState) ElementType ¶
func (AssignmentState) ElementType() reflect.Type
type Definition ¶
type Definition struct { pulumi.CustomResourceState // The description of the policy definition. Description pulumi.StringPtrOutput `pulumi:"description"` // The display name of the policy definition. DisplayName pulumi.StringOutput `pulumi:"displayName"` ManagementGroupId pulumi.StringOutput `pulumi:"managementGroupId"` // The name of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupName pulumi.StringOutput `pulumi:"managementGroupName"` // The metadata for the policy definition. This // is a json object representing additional metadata that should be stored // with the policy definition. Metadata pulumi.StringOutput `pulumi:"metadata"` // The policy mode that allows you to specify which resource // types will be evaluated. The value can be "All", "Indexed" or // "NotSpecified". Changing this resource forces a new resource to be // created. Mode pulumi.StringOutput `pulumi:"mode"` // The name of the policy definition. Changing this forces a // new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // Parameters for the policy definition. This field // is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrOutput `pulumi:"parameters"` // The policy rule for the policy definition. This // is a json object representing the rule that contains an if and // a then block. PolicyRule pulumi.StringPtrOutput `pulumi:"policyRule"` // The policy type. Possible values are `BuiltIn`, `Custom` and `NotSpecified`. Changing this forces a new resource to be created. PolicyType pulumi.StringOutput `pulumi:"policyType"` }
Manages a policy rule definition on a management group or your provider subscription.
Policy definitions do not take effect until they are assigned to a scope using a Policy Assignment.
func GetDefinition ¶
func GetDefinition(ctx *pulumi.Context, name string, id pulumi.IDInput, state *DefinitionState, opts ...pulumi.ResourceOption) (*Definition, error)
GetDefinition gets an existing Definition resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewDefinition ¶
func NewDefinition(ctx *pulumi.Context, name string, args *DefinitionArgs, opts ...pulumi.ResourceOption) (*Definition, error)
NewDefinition registers a new resource with the given unique name, arguments, and options.
type DefinitionArgs ¶
type DefinitionArgs struct { // The description of the policy definition. Description pulumi.StringPtrInput // The display name of the policy definition. DisplayName pulumi.StringInput ManagementGroupId pulumi.StringPtrInput // The name of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupName pulumi.StringPtrInput // The metadata for the policy definition. This // is a json object representing additional metadata that should be stored // with the policy definition. Metadata pulumi.StringPtrInput // The policy mode that allows you to specify which resource // types will be evaluated. The value can be "All", "Indexed" or // "NotSpecified". Changing this resource forces a new resource to be // created. Mode pulumi.StringInput // The name of the policy definition. Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // Parameters for the policy definition. This field // is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrInput // The policy rule for the policy definition. This // is a json object representing the rule that contains an if and // a then block. PolicyRule pulumi.StringPtrInput // The policy type. Possible values are `BuiltIn`, `Custom` and `NotSpecified`. Changing this forces a new resource to be created. PolicyType pulumi.StringInput }
The set of arguments for constructing a Definition resource.
func (DefinitionArgs) ElementType ¶
func (DefinitionArgs) ElementType() reflect.Type
type DefinitionState ¶
type DefinitionState struct { // The description of the policy definition. Description pulumi.StringPtrInput // The display name of the policy definition. DisplayName pulumi.StringPtrInput ManagementGroupId pulumi.StringPtrInput // The name of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupName pulumi.StringPtrInput // The metadata for the policy definition. This // is a json object representing additional metadata that should be stored // with the policy definition. Metadata pulumi.StringPtrInput // The policy mode that allows you to specify which resource // types will be evaluated. The value can be "All", "Indexed" or // "NotSpecified". Changing this resource forces a new resource to be // created. Mode pulumi.StringPtrInput // The name of the policy definition. Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // Parameters for the policy definition. This field // is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrInput // The policy rule for the policy definition. This // is a json object representing the rule that contains an if and // a then block. PolicyRule pulumi.StringPtrInput // The policy type. Possible values are `BuiltIn`, `Custom` and `NotSpecified`. Changing this forces a new resource to be created. PolicyType pulumi.StringPtrInput }
func (DefinitionState) ElementType ¶
func (DefinitionState) ElementType() reflect.Type
type GetPolicyDefintionArgs ¶
type GetPolicyDefintionArgs struct { // Specifies the display name of the Policy Definition. Conflicts with `name`. DisplayName *string `pulumi:"displayName"` ManagementGroupId *string `pulumi:"managementGroupId"` // Only retrieve Policy Definitions from this Management Group. ManagementGroupName *string `pulumi:"managementGroupName"` // Specifies the name of the Policy Definition. Conflicts with `displayName`. Name *string `pulumi:"name"` }
A collection of arguments for invoking getPolicyDefintion.
type GetPolicyDefintionResult ¶
type GetPolicyDefintionResult struct { // The Description of the Policy. Description string `pulumi:"description"` DisplayName string `pulumi:"displayName"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` ManagementGroupId *string `pulumi:"managementGroupId"` ManagementGroupName *string `pulumi:"managementGroupName"` // Any Metadata defined in the Policy. Metadata string `pulumi:"metadata"` Name string `pulumi:"name"` // Any Parameters defined in the Policy. Parameters string `pulumi:"parameters"` // The Rule as defined (in JSON) in the Policy. PolicyRule string `pulumi:"policyRule"` // The Type of the Policy. Possible values are "BuiltIn", "Custom" and "NotSpecified". PolicyType string `pulumi:"policyType"` // The Type of Policy. Type string `pulumi:"type"` }
A collection of values returned by getPolicyDefintion.
func GetPolicyDefintion ¶
func GetPolicyDefintion(ctx *pulumi.Context, args *GetPolicyDefintionArgs, opts ...pulumi.InvokeOption) (*GetPolicyDefintionResult, error)
Use this data source to access information about a Policy Definition, both custom and built in. Retrieves Policy Definitions from your current subscription by default.
type LookupPolicySetDefinitionArgs ¶ added in v3.1.0
type LookupPolicySetDefinitionArgs struct { // Specifies the display name of the Policy Set Definition. Conflicts with `name`. DisplayName *string `pulumi:"displayName"` // Only retrieve Policy Set Definitions from this Management Group. ManagementGroupName *string `pulumi:"managementGroupName"` // Specifies the name of the Policy Set Definition. Conflicts with `displayName`. Name *string `pulumi:"name"` }
A collection of arguments for invoking getPolicySetDefinition.
type LookupPolicySetDefinitionResult ¶ added in v3.1.0
type LookupPolicySetDefinitionResult struct { // The Description of the Policy Set Definition. Description string `pulumi:"description"` DisplayName string `pulumi:"displayName"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` ManagementGroupName *string `pulumi:"managementGroupName"` // Any Metadata defined in the Policy Set Definition. Metadata string `pulumi:"metadata"` Name string `pulumi:"name"` // Any Parameters defined in the Policy Set Definition. Parameters string `pulumi:"parameters"` // The policy definitions contained within the policy set definition. PolicyDefinitions string `pulumi:"policyDefinitions"` // The Type of the Policy Set Definition. PolicyType string `pulumi:"policyType"` }
A collection of values returned by getPolicySetDefinition.
func LookupPolicySetDefinition ¶ added in v3.1.0
func LookupPolicySetDefinition(ctx *pulumi.Context, args *LookupPolicySetDefinitionArgs, opts ...pulumi.InvokeOption) (*LookupPolicySetDefinitionResult, error)
Use this data source to access information about an existing Policy Set Definition.
type PolicySetDefinition ¶
type PolicySetDefinition struct { pulumi.CustomResourceState // The description of the policy set definition. Description pulumi.StringPtrOutput `pulumi:"description"` // The display name of the policy set definition. DisplayName pulumi.StringOutput `pulumi:"displayName"` // The ID of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupId pulumi.StringPtrOutput `pulumi:"managementGroupId"` // The metadata for the policy set definition. This is a json object representing additional metadata that should be stored with the policy definition. Metadata pulumi.StringOutput `pulumi:"metadata"` // The name of the policy set definition. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // Parameters for the policy set definition. This field is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrOutput `pulumi:"parameters"` // The policy definitions for the policy set definition. This is a json object representing the bundled policy definitions. PolicyDefinitions pulumi.StringPtrOutput `pulumi:"policyDefinitions"` // The policy set type. Possible values are `BuiltIn` or `Custom`. Changing this forces a new resource to be created. PolicyType pulumi.StringOutput `pulumi:"policyType"` }
Manages a policy set definition.
> **NOTE:** Policy set definitions (also known as policy initiatives) do not take effect until they are assigned to a scope using a Policy Set Assignment.
func GetPolicySetDefinition ¶
func GetPolicySetDefinition(ctx *pulumi.Context, name string, id pulumi.IDInput, state *PolicySetDefinitionState, opts ...pulumi.ResourceOption) (*PolicySetDefinition, error)
GetPolicySetDefinition gets an existing PolicySetDefinition resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPolicySetDefinition ¶
func NewPolicySetDefinition(ctx *pulumi.Context, name string, args *PolicySetDefinitionArgs, opts ...pulumi.ResourceOption) (*PolicySetDefinition, error)
NewPolicySetDefinition registers a new resource with the given unique name, arguments, and options.
type PolicySetDefinitionArgs ¶
type PolicySetDefinitionArgs struct { // The description of the policy set definition. Description pulumi.StringPtrInput // The display name of the policy set definition. DisplayName pulumi.StringInput // The ID of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupId pulumi.StringPtrInput // The metadata for the policy set definition. This is a json object representing additional metadata that should be stored with the policy definition. Metadata pulumi.StringPtrInput // The name of the policy set definition. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Parameters for the policy set definition. This field is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrInput // The policy definitions for the policy set definition. This is a json object representing the bundled policy definitions. PolicyDefinitions pulumi.StringPtrInput // The policy set type. Possible values are `BuiltIn` or `Custom`. Changing this forces a new resource to be created. PolicyType pulumi.StringInput }
The set of arguments for constructing a PolicySetDefinition resource.
func (PolicySetDefinitionArgs) ElementType ¶
func (PolicySetDefinitionArgs) ElementType() reflect.Type
type PolicySetDefinitionState ¶
type PolicySetDefinitionState struct { // The description of the policy set definition. Description pulumi.StringPtrInput // The display name of the policy set definition. DisplayName pulumi.StringPtrInput // The ID of the Management Group where this policy should be defined. Changing this forces a new resource to be created. ManagementGroupId pulumi.StringPtrInput // The metadata for the policy set definition. This is a json object representing additional metadata that should be stored with the policy definition. Metadata pulumi.StringPtrInput // The name of the policy set definition. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Parameters for the policy set definition. This field is a json object that allows you to parameterize your policy definition. Parameters pulumi.StringPtrInput // The policy definitions for the policy set definition. This is a json object representing the bundled policy definitions. PolicyDefinitions pulumi.StringPtrInput // The policy set type. Possible values are `BuiltIn` or `Custom`. Changing this forces a new resource to be created. PolicyType pulumi.StringPtrInput }
func (PolicySetDefinitionState) ElementType ¶
func (PolicySetDefinitionState) ElementType() reflect.Type
type Remediation ¶
type Remediation struct { pulumi.CustomResourceState // A list of the resource locations that will be remediated. LocationFilters pulumi.StringArrayOutput `pulumi:"locationFilters"` // The name of the Policy Remediation. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The resource ID of the policy assignment that should be remediated. PolicyAssignmentId pulumi.StringOutput `pulumi:"policyAssignmentId"` // The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. PolicyDefinitionReferenceId pulumi.StringPtrOutput `pulumi:"policyDefinitionReferenceId"` // The Scope at which the Policy Remediation should be applied. Changing this forces a new resource to be created. A scope must be a Resource ID out of one of the following list: Scope pulumi.StringOutput `pulumi:"scope"` }
Manages an Azure Policy Remediation at the specified Scope.
func GetRemediation ¶
func GetRemediation(ctx *pulumi.Context, name string, id pulumi.IDInput, state *RemediationState, opts ...pulumi.ResourceOption) (*Remediation, error)
GetRemediation gets an existing Remediation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewRemediation ¶
func NewRemediation(ctx *pulumi.Context, name string, args *RemediationArgs, opts ...pulumi.ResourceOption) (*Remediation, error)
NewRemediation registers a new resource with the given unique name, arguments, and options.
type RemediationArgs ¶
type RemediationArgs struct { // A list of the resource locations that will be remediated. LocationFilters pulumi.StringArrayInput // The name of the Policy Remediation. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The resource ID of the policy assignment that should be remediated. PolicyAssignmentId pulumi.StringInput // The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. PolicyDefinitionReferenceId pulumi.StringPtrInput // The Scope at which the Policy Remediation should be applied. Changing this forces a new resource to be created. A scope must be a Resource ID out of one of the following list: Scope pulumi.StringInput }
The set of arguments for constructing a Remediation resource.
func (RemediationArgs) ElementType ¶
func (RemediationArgs) ElementType() reflect.Type
type RemediationState ¶
type RemediationState struct { // A list of the resource locations that will be remediated. LocationFilters pulumi.StringArrayInput // The name of the Policy Remediation. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The resource ID of the policy assignment that should be remediated. PolicyAssignmentId pulumi.StringPtrInput // The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. PolicyDefinitionReferenceId pulumi.StringPtrInput // The Scope at which the Policy Remediation should be applied. Changing this forces a new resource to be created. A scope must be a Resource ID out of one of the following list: Scope pulumi.StringPtrInput }
func (RemediationState) ElementType ¶
func (RemediationState) ElementType() reflect.Type