Retention Policies - Create Or Replace

Başvuru

Hizmet:: Durable Task Scheduler

API Sürümü:: 2025-04-01-preview

Bekletme İlkesi Oluşturma veya Güncelleştirme

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default?api-version=2025-04-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
schedulerName	path	True	string pattern: ^[a-zA-Z0-9-]{3,64}$	Zamanlayıcının adı
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties	RetentionPolicyProperties	Bu kaynağın kaynağa özgü özellikleri.

Yanıtlar

Name

Tür

Description

200 OK

RetentionPolicy

Kaynak 'RetentionPolicy' güncelleştirme işlemi başarılı oldu

201 Created

RetentionPolicy

Kaynak 'RetentionPolicy' oluşturma işlemi başarılı oldu

Üst Bilgiler

Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

Doğrulama hatası: Gerekli parametreler eksik

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

RetentionPolicies_CreateOrReplace_MaximumSet

Örnek isteği

PUT https://management.azure.com/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default?api-version=2025-04-01-preview

{
  "properties": {
    "retentionPolicies": [
      {
        "retentionPeriodInDays": 30
      },
      {
        "retentionPeriodInDays": 10,
        "orchestrationState": "Failed"
      }
    ]
  }
}


import com.azure.resourcemanager.durabletask.fluent.models.RetentionPolicyInner;
import com.azure.resourcemanager.durabletask.models.PurgeableOrchestrationState;
import com.azure.resourcemanager.durabletask.models.RetentionPolicyDetails;
import com.azure.resourcemanager.durabletask.models.RetentionPolicyProperties;
import java.util.Arrays;

/**
 * Samples for RetentionPolicies CreateOrReplace.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
     */
    /**
     * Sample code: RetentionPolicies_CreateOrReplace_MaximumSet.
     * 
     * @param manager Entry point to DurableTaskManager.
     */
    public static void
        retentionPoliciesCreateOrReplaceMaximumSet(com.azure.resourcemanager.durabletask.DurableTaskManager manager) {
        manager.retentionPolicies().createOrReplace("rgdurabletask", "testscheduler",
            new RetentionPolicyInner().withProperties(new RetentionPolicyProperties()
                .withRetentionPolicies(Arrays.asList(new RetentionPolicyDetails().withRetentionPeriodInDays(30),
                    new RetentionPolicyDetails().withRetentionPeriodInDays(10)
                        .withOrchestrationState(PurgeableOrchestrationState.FAILED)))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.durabletask import DurableTaskMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-durabletask
# USAGE
    python retention_policies_create_or_replace_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DurableTaskMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.retention_policies.begin_create_or_replace(
        resource_group_name="rgdurabletask",
        scheduler_name="testscheduler",
        resource={
            "properties": {
                "retentionPolicies": [
                    {"retentionPeriodInDays": 30},
                    {"orchestrationState": "Failed", "retentionPeriodInDays": 10},
                ]
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdurabletask_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/durabletask/armdurabletask"
)

// Generated from example definition: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
func ExampleRetentionPoliciesClient_BeginCreateOrReplace() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdurabletask.NewClientFactory("194D3C1E-462F-4738-9025-092A628C06EB", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRetentionPoliciesClient().BeginCreateOrReplace(ctx, "rgdurabletask", "testscheduler", armdurabletask.RetentionPolicy{
		Properties: &armdurabletask.RetentionPolicyProperties{
			RetentionPolicies: []*armdurabletask.RetentionPolicyDetails{
				{
					RetentionPeriodInDays: to.Ptr[int32](30),
				},
				{
					RetentionPeriodInDays: to.Ptr[int32](10),
					OrchestrationState:    to.Ptr(armdurabletask.PurgeableOrchestrationStateFailed),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdurabletask.RetentionPoliciesClientCreateOrReplaceResponse{
	// 	RetentionPolicy: &armdurabletask.RetentionPolicy{
	// 		Properties: &armdurabletask.RetentionPolicyProperties{
	// 			ProvisioningState: to.Ptr(armdurabletask.ProvisioningStateSucceeded),
	// 			RetentionPolicies: []*armdurabletask.RetentionPolicyDetails{
	// 				{
	// 					RetentionPeriodInDays: to.Ptr[int32](30),
	// 				},
	// 				{
	// 					RetentionPeriodInDays: to.Ptr[int32](10),
	// 					OrchestrationState: to.Ptr(armdurabletask.PurgeableOrchestrationStateFailed),
	// 				},
	// 			},
	// 		},
	// 		ID: to.Ptr("/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default"),
	// 		Name: to.Ptr("default"),
	// 		Type: to.Ptr("Microsoft.DurableTask/schedulers/retentionPolicies"),
	// 		SystemData: &armdurabletask.SystemData{
	// 			CreatedBy: to.Ptr("zshkmc"),
	// 			CreatedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-03-31T23:34:09.612Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("ivqrae"),
	// 			LastModifiedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-03-31T23:34:09.612Z"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DurableTaskClient } = require("@azure/arm-durabletask");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create or Update a Retention Policy
 *
 * @summary create or Update a Retention Policy
 * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
 */
async function retentionPoliciesCreateOrReplaceMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "194D3C1E-462F-4738-9025-092A628C06EB";
  const client = new DurableTaskClient(credential, subscriptionId);
  const result = await client.retentionPolicies.createOrReplace("rgdurabletask", "testscheduler", {
    properties: {
      retentionPolicies: [
        { retentionPeriodInDays: 30 },
        { retentionPeriodInDays: 10, orchestrationState: "Failed" },
      ],
    },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DurableTask.Models;
using Azure.ResourceManager.DurableTask;

// Generated from example definition: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
// this example is just showing the usage of "RetentionPolicy_CreateOrReplace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DurableTaskRetentionPolicyResource created on azure
// for more information of creating DurableTaskRetentionPolicyResource, please refer to the document of DurableTaskRetentionPolicyResource
string subscriptionId = "194D3C1E-462F-4738-9025-092A628C06EB";
string resourceGroupName = "rgdurabletask";
string schedulerName = "testscheduler";
ResourceIdentifier durableTaskRetentionPolicyResourceId = DurableTaskRetentionPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, schedulerName);
DurableTaskRetentionPolicyResource durableTaskRetentionPolicy = client.GetDurableTaskRetentionPolicyResource(durableTaskRetentionPolicyResourceId);

// invoke the operation
DurableTaskRetentionPolicyData data = new DurableTaskRetentionPolicyData
{
    Properties = new DurableTaskRetentionPolicyProperties
    {
        RetentionPolicies = {new DurableTaskRetentionPolicyDetails(30), new DurableTaskRetentionPolicyDetails(10)
        {
        OrchestrationState = DurableTaskPurgeableOrchestrationState.Failed,
        }},
    },
};
ArmOperation<DurableTaskRetentionPolicyResource> lro = await durableTaskRetentionPolicy.CreateOrUpdateAsync(WaitUntil.Completed, data);
DurableTaskRetentionPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DurableTaskRetentionPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "properties": {
    "provisioningState": "Succeeded",
    "retentionPolicies": [
      {
        "retentionPeriodInDays": 30
      },
      {
        "retentionPeriodInDays": 10,
        "orchestrationState": "Failed"
      }
    ]
  },
  "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default",
  "name": "default",
  "type": "Microsoft.DurableTask/schedulers/retentionPolicies",
  "systemData": {
    "createdBy": "zshkmc",
    "createdByType": "User",
    "createdAt": "2025-03-31T23:34:09.612Z",
    "lastModifiedBy": "ivqrae",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2025-03-31T23:34:09.612Z"
  }
}

Durum kodu:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "provisioningState": "Succeeded",
    "retentionPolicies": [
      {
        "retentionPeriodInDays": 30
      },
      {
        "retentionPeriodInDays": 10,
        "orchestrationState": "Failed"
      }
    ]
  },
  "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default",
  "name": "default",
  "type": "Microsoft.DurableTask/schedulers/retentionPolicies",
  "systemData": {
    "createdBy": "zshkmc",
    "createdByType": "User",
    "createdAt": "2025-03-31T23:34:09.612Z",
    "lastModifiedBy": "ivqrae",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2025-03-31T23:34:09.612Z"
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ProvisioningState	Geçerli işlemin durumu
PurgeableOrchestrationState	Bekletme ilkelerinde kullanılacak temizlenebilir düzenleme durumu
RetentionPolicy	Zamanlayıcıya ait bir bekletme ilkesi kaynağı
RetentionPolicyDetails	Bekletme ilkesinin özellikleri
RetentionPolicyProperties	Kaynağın bekletme ilkesi ayarları
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ProvisioningState

Listeleme

Geçerli işlemin durumu

Değer	Description
Accepted	Kaynak oluşturma isteği kabul edildi
Canceled	Kaynak oluşturma işlemi iptal edildi.
Deleting	Kaynak siliniyor
Failed	Kaynak oluşturulamadı.
Provisioning	Kaynak sağlanıyor
Succeeded	Kaynak oluşturuldu.
Updating	Kaynak güncelleştiriliyor

PurgeableOrchestrationState

Listeleme

Bekletme ilkelerinde kullanılacak temizlenebilir düzenleme durumu

Değer	Description
Canceled	Düzenleme iptal edildi
Completed	Düzenleme tamamlandı
Failed	Düzenleme başarısız oldu
Terminated	Düzenleme sonlandırıldı

RetentionPolicy

Object

Zamanlayıcıya ait bir bekletme ilkesi kaynağı

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties	RetentionPolicyProperties	Bu kaynağın kaynağa özgü özellikleri.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

RetentionPolicyDetails

Object

Bekletme ilkesinin özellikleri

Name	Tür	Description
orchestrationState	PurgeableOrchestrationState	Bu ilkenin geçerli olduğu düzenleme durumu. Belirtilmezse, ilke tüm temizlenebilir düzenleme durumlarına uygulanır.
retentionPeriodInDays	integer (int32)	Düzenlemenin otomatik olarak temizlendiği gün cinsinden saklama süresi

RetentionPolicyProperties

Object

Kaynağın bekletme ilkesi ayarları

Name	Tür	Description
provisioningState	ProvisioningState	Son işlemin durumu
retentionPolicies	RetentionPolicyDetails[]	Düzenleme bekletme ilkeleri

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.