azure-native.authorization.getPolicyExemption
Explore with Pulumi AI
This operation retrieves a single policy exemption, given its name and the scope it was created at.
Uses Azure REST API version 2022-07-01-preview.
Other available API versions: 2020-07-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native authorization [ApiVersion]
. See the version guide for details.
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)
public static Output<GetPolicyExemptionResult> getPolicyExemption(GetPolicyExemptionArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:authorization:getPolicyExemption
arguments:
# arguments dictionary
The following arguments are supported:
- Policy
Exemption stringName - 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 stringName - 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 StringName - 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 stringName - 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_ strname - 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}'
- policy
Exemption StringName - 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- Exemption
Category 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.
- Policy
Assignment stringId - The ID of the policy assignment that is being exempted.
- System
Data Pulumi.Azure Native. Authorization. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource (Microsoft.Authorization/policyExemptions).
- Assignment
Scope stringValidation - The option whether validate the exemption is at or under the assignment scope.
- Description string
- The description of the policy exemption.
- Display
Name string - The display name of the policy exemption.
- Expires
On 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.
- Policy
Definition List<string>Reference Ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- Resource
Selectors List<Pulumi.Azure Native. Authorization. Outputs. Resource Selector Response> - The resource selector list to filter policies by resource properties.
- Azure
Api stringVersion - The Azure API version of the resource.
- Exemption
Category 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.
- Policy
Assignment stringId - The ID of the policy assignment that is being exempted.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource (Microsoft.Authorization/policyExemptions).
- Assignment
Scope stringValidation - The option whether validate the exemption is at or under the assignment scope.
- Description string
- The description of the policy exemption.
- Display
Name string - The display name of the policy exemption.
- Expires
On 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.
- Policy
Definition []stringReference Ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- Resource
Selectors []ResourceSelector Response - The resource selector list to filter policies by resource properties.
- azure
Api StringVersion - The Azure API version of the resource.
- exemption
Category 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.
- policy
Assignment StringId - The ID of the policy assignment that is being exempted.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource (Microsoft.Authorization/policyExemptions).
- assignment
Scope StringValidation - The option whether validate the exemption is at or under the assignment scope.
- description String
- The description of the policy exemption.
- display
Name String - The display name of the policy exemption.
- expires
On 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.
- policy
Definition List<String>Reference Ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- resource
Selectors List<ResourceSelector Response> - The resource selector list to filter policies by resource properties.
- azure
Api stringVersion - The Azure API version of the resource.
- exemption
Category 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.
- policy
Assignment stringId - The ID of the policy assignment that is being exempted.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource (Microsoft.Authorization/policyExemptions).
- assignment
Scope stringValidation - The option whether validate the exemption is at or under the assignment scope.
- description string
- The description of the policy exemption.
- display
Name string - The display name of the policy exemption.
- expires
On 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.
- policy
Definition string[]Reference Ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- resource
Selectors ResourceSelector Response[] - The resource selector list to filter policies by resource properties.
- azure_
api_ strversion - The Azure API version of the resource.
- 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_ strid - The ID of the policy assignment that is being exempted.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource (Microsoft.Authorization/policyExemptions).
- assignment_
scope_ strvalidation - 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_ Sequence[str]reference_ ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- resource_
selectors Sequence[ResourceSelector Response] - The resource selector list to filter policies by resource properties.
- azure
Api StringVersion - The Azure API version of the resource.
- exemption
Category 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.
- policy
Assignment StringId - The ID of the policy assignment that is being exempted.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource (Microsoft.Authorization/policyExemptions).
- assignment
Scope StringValidation - The option whether validate the exemption is at or under the assignment scope.
- description String
- The description of the policy exemption.
- display
Name String - The display name of the policy exemption.
- expires
On 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.
- policy
Definition List<String>Reference Ids - The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.
- resource
Selectors 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.
Azure Native. Authorization. Inputs. Selector Response> - The list of the selector expressions.
- Name string
- The name of the resource selector.
- Selectors
[]Selector
Response - The list of the selector expressions.
- name String
- The name of the resource selector.
- selectors
List<Selector
Response> - The list of the selector expressions.
- name string
- The name of the resource selector.
- selectors
Selector
Response[] - The list of the selector expressions.
- name str
- The name of the resource selector.
- selectors
Sequence[Selector
Response] - 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
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