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

azure-native.authorization.getPolicyExemption

Explore with Pulumi AI

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

    This operation retrieves a single policy exemption, given its name and the scope it was created at. Azure REST API version: 2022-07-01-preview.

    Using getPolicyExemption

    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 getPolicyExemption(args: GetPolicyExemptionArgs, opts?: InvokeOptions): Promise<GetPolicyExemptionResult>
    function getPolicyExemptionOutput(args: GetPolicyExemptionOutputArgs, opts?: InvokeOptions): Output<GetPolicyExemptionResult>
    def get_policy_exemption(policy_exemption_name: Optional[str] = None,
                             scope: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPolicyExemptionResult
    def get_policy_exemption_output(policy_exemption_name: Optional[pulumi.Input[str]] = None,
                             scope: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPolicyExemptionResult]
    func LookupPolicyExemption(ctx *Context, args *LookupPolicyExemptionArgs, opts ...InvokeOption) (*LookupPolicyExemptionResult, error)
    func LookupPolicyExemptionOutput(ctx *Context, args *LookupPolicyExemptionOutputArgs, opts ...InvokeOption) LookupPolicyExemptionResultOutput

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

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

    The following arguments are supported:

    PolicyExemptionName string
    The name of the policy exemption to delete.
    Scope string
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
    PolicyExemptionName string
    The name of the policy exemption to delete.
    Scope string
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
    policyExemptionName String
    The name of the policy exemption to delete.
    scope String
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
    policyExemptionName string
    The name of the policy exemption to delete.
    scope string
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
    policy_exemption_name str
    The name of the policy exemption to delete.
    scope str
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
    policyExemptionName String
    The name of the policy exemption to delete.
    scope String
    The scope of the policy exemption. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'

    getPolicyExemption Result

    The following output properties are available:

    ExemptionCategory string
    The policy exemption category. Possible values are Waiver and Mitigated.
    Id string
    The ID of the policy exemption.
    Name string
    The name of the policy exemption.
    PolicyAssignmentId string
    The ID of the policy assignment that is being exempted.
    SystemData Pulumi.AzureNative.Authorization.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource (Microsoft.Authorization/policyExemptions).
    AssignmentScopeValidation string
    The option whether validate the exemption is at or under the assignment scope.
    Description string
    The description of the policy exemption.
    DisplayName string
    The display name of the policy exemption.
    ExpiresOn string
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    Metadata object
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    PolicyDefinitionReferenceIds List<string>
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    ResourceSelectors List<Pulumi.AzureNative.Authorization.Outputs.ResourceSelectorResponse>
    The resource selector list to filter policies by resource properties.
    ExemptionCategory string
    The policy exemption category. Possible values are Waiver and Mitigated.
    Id string
    The ID of the policy exemption.
    Name string
    The name of the policy exemption.
    PolicyAssignmentId string
    The ID of the policy assignment that is being exempted.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource (Microsoft.Authorization/policyExemptions).
    AssignmentScopeValidation string
    The option whether validate the exemption is at or under the assignment scope.
    Description string
    The description of the policy exemption.
    DisplayName string
    The display name of the policy exemption.
    ExpiresOn string
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    Metadata interface{}
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    PolicyDefinitionReferenceIds []string
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    ResourceSelectors []ResourceSelectorResponse
    The resource selector list to filter policies by resource properties.
    exemptionCategory String
    The policy exemption category. Possible values are Waiver and Mitigated.
    id String
    The ID of the policy exemption.
    name String
    The name of the policy exemption.
    policyAssignmentId String
    The ID of the policy assignment that is being exempted.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource (Microsoft.Authorization/policyExemptions).
    assignmentScopeValidation String
    The option whether validate the exemption is at or under the assignment scope.
    description String
    The description of the policy exemption.
    displayName String
    The display name of the policy exemption.
    expiresOn String
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    metadata Object
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    policyDefinitionReferenceIds List<String>
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    resourceSelectors List<ResourceSelectorResponse>
    The resource selector list to filter policies by resource properties.
    exemptionCategory string
    The policy exemption category. Possible values are Waiver and Mitigated.
    id string
    The ID of the policy exemption.
    name string
    The name of the policy exemption.
    policyAssignmentId string
    The ID of the policy assignment that is being exempted.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource (Microsoft.Authorization/policyExemptions).
    assignmentScopeValidation string
    The option whether validate the exemption is at or under the assignment scope.
    description string
    The description of the policy exemption.
    displayName string
    The display name of the policy exemption.
    expiresOn string
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    metadata any
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    policyDefinitionReferenceIds string[]
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    resourceSelectors ResourceSelectorResponse[]
    The resource selector list to filter policies by resource properties.
    exemption_category str
    The policy exemption category. Possible values are Waiver and Mitigated.
    id str
    The ID of the policy exemption.
    name str
    The name of the policy exemption.
    policy_assignment_id str
    The ID of the policy assignment that is being exempted.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource (Microsoft.Authorization/policyExemptions).
    assignment_scope_validation str
    The option whether validate the exemption is at or under the assignment scope.
    description str
    The description of the policy exemption.
    display_name str
    The display name of the policy exemption.
    expires_on str
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    metadata Any
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    policy_definition_reference_ids Sequence[str]
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    resource_selectors Sequence[ResourceSelectorResponse]
    The resource selector list to filter policies by resource properties.
    exemptionCategory String
    The policy exemption category. Possible values are Waiver and Mitigated.
    id String
    The ID of the policy exemption.
    name String
    The name of the policy exemption.
    policyAssignmentId String
    The ID of the policy assignment that is being exempted.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource (Microsoft.Authorization/policyExemptions).
    assignmentScopeValidation String
    The option whether validate the exemption is at or under the assignment scope.
    description String
    The description of the policy exemption.
    displayName String
    The display name of the policy exemption.
    expiresOn String
    The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.
    metadata Any
    The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.
    policyDefinitionReferenceIds List<String>
    The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
    resourceSelectors List<Property Map>
    The resource selector list to filter policies by resource properties.

    Supporting Types

    ResourceSelectorResponse

    Name string
    The name of the resource selector.
    Selectors List<Pulumi.AzureNative.Authorization.Inputs.SelectorResponse>
    The list of the selector expressions.
    Name string
    The name of the resource selector.
    Selectors []SelectorResponse
    The list of the selector expressions.
    name String
    The name of the resource selector.
    selectors List<SelectorResponse>
    The list of the selector expressions.
    name string
    The name of the resource selector.
    selectors SelectorResponse[]
    The list of the selector expressions.
    name str
    The name of the resource selector.
    selectors Sequence[SelectorResponse]
    The list of the selector expressions.
    name String
    The name of the resource selector.
    selectors List<Property Map>
    The list of the selector expressions.

    SelectorResponse

    In List<string>
    The list of values to filter in.
    Kind string
    The selector kind.
    NotIn List<string>
    The list of values to filter out.
    In []string
    The list of values to filter in.
    Kind string
    The selector kind.
    NotIn []string
    The list of values to filter out.
    in List<String>
    The list of values to filter in.
    kind String
    The selector kind.
    notIn List<String>
    The list of values to filter out.
    in string[]
    The list of values to filter in.
    kind string
    The selector kind.
    notIn string[]
    The list of values to filter out.
    in_ Sequence[str]
    The list of values to filter in.
    kind str
    The selector kind.
    not_in Sequence[str]
    The list of values to filter out.
    in List<String>
    The list of values to filter in.
    kind String
    The selector kind.
    notIn List<String>
    The list of values to filter out.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

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