Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. durabletask
  5. getRetentionPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.durabletask.getRetentionPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a Retention Policy

    Uses Azure REST API version 2025-04-01-preview.

    Using getRetentionPolicy

    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 getRetentionPolicy(args: GetRetentionPolicyArgs, opts?: InvokeOptions): Promise<GetRetentionPolicyResult>
function getRetentionPolicyOutput(args: GetRetentionPolicyOutputArgs, opts?: InvokeOptions): Output<GetRetentionPolicyResult>
    def get_retention_policy(resource_group_name: Optional[str] = None,
                         scheduler_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRetentionPolicyResult
def get_retention_policy_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                         scheduler_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRetentionPolicyResult]
    func LookupRetentionPolicy(ctx *Context, args *LookupRetentionPolicyArgs, opts ...InvokeOption) (*LookupRetentionPolicyResult, error)
func LookupRetentionPolicyOutput(ctx *Context, args *LookupRetentionPolicyOutputArgs, opts ...InvokeOption) LookupRetentionPolicyResultOutput

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

    public static class GetRetentionPolicy 
{
    public static Task<GetRetentionPolicyResult> InvokeAsync(GetRetentionPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetRetentionPolicyResult> Invoke(GetRetentionPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRetentionPolicyResult> getRetentionPolicy(GetRetentionPolicyArgs args, InvokeOptions options)
public static Output<GetRetentionPolicyResult> getRetentionPolicy(GetRetentionPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:durabletask:getRetentionPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SchedulerName string
    The name of the Scheduler
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SchedulerName string
    The name of the Scheduler
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    schedulerName String
    The name of the Scheduler
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    schedulerName string
    The name of the Scheduler
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    scheduler_name str
    The name of the Scheduler
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    schedulerName String
    The name of the Scheduler

    getRetentionPolicy Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.DurableTask.Outputs.RetentionPolicyPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.DurableTask.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties RetentionPolicyPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties RetentionPolicyPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties RetentionPolicyPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties RetentionPolicyPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    RetentionPolicyDetailsResponse

    RetentionPeriodInDays int
    The retention period in days after which the orchestration will be purged automatically
    OrchestrationState string
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
    RetentionPeriodInDays int
    The retention period in days after which the orchestration will be purged automatically
    OrchestrationState string
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
    retentionPeriodInDays Integer
    The retention period in days after which the orchestration will be purged automatically
    orchestrationState String
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
    retentionPeriodInDays number
    The retention period in days after which the orchestration will be purged automatically
    orchestrationState string
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
    retention_period_in_days int
    The retention period in days after which the orchestration will be purged automatically
    orchestration_state str
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
    retentionPeriodInDays Number
    The retention period in days after which the orchestration will be purged automatically
    orchestrationState String
    The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.

    RetentionPolicyPropertiesResponse

    ProvisioningState string
    The status of the last operation
    RetentionPolicies List<Pulumi.AzureNative.DurableTask.Inputs.RetentionPolicyDetailsResponse>
    The orchestration retention policies
    ProvisioningState string
    The status of the last operation
    RetentionPolicies []RetentionPolicyDetailsResponse
    The orchestration retention policies
    provisioningState String
    The status of the last operation
    retentionPolicies List<RetentionPolicyDetailsResponse>
    The orchestration retention policies
    provisioningState string
    The status of the last operation
    retentionPolicies RetentionPolicyDetailsResponse[]
    The orchestration retention policies
    provisioning_state str
    The status of the last operation
    retention_policies Sequence[RetentionPolicyDetailsResponse]
    The orchestration retention policies
    provisioningState String
    The status of the last operation
    retentionPolicies List<Property Map>
    The orchestration retention policies

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native