Patch Schedules - Create Or Update

Referenz

Service:: Redis Cache

API Version:: 2023-08-01

Erstellen oder ersetzen Sie den Patchzeitplan für redis cache.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/default?api-version=2023-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
default	path	True	defaultName	Standardzeichenfolge, die als Parameter modelliert wird, damit die automatische Generierung ordnungsgemäß funktioniert.
name	path	True	string	Der Name des Redis-Caches.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.scheduleEntries	True	ScheduleEntry[]	Liste der Patchzeitpläne für einen Redis-Cache.

Antworten

Name	Typ	Beschreibung
200 OK	RedisPatchSchedule	Der Patchzeitplan wurde erfolgreich aktualisiert.
201 Created	RedisPatchSchedule	Der Patchzeitplan wurde erfolgreich erstellt.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

RedisCachePatchSchedulesCreateOrUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/patchSchedules/default?api-version=2023-08-01

{
  "properties": {
    "scheduleEntries": [
      {
        "dayOfWeek": "Monday",
        "startHourUtc": 12,
        "maintenanceWindow": "PT5H"
      },
      {
        "dayOfWeek": "Tuesday",
        "startHourUtc": 12
      }
    ]
  }
}


import com.azure.resourcemanager.redis.fluent.models.RedisPatchScheduleInner;
import com.azure.resourcemanager.redis.models.DayOfWeek;
import com.azure.resourcemanager.redis.models.DefaultName;
import com.azure.resourcemanager.redis.models.ScheduleEntry;
import java.time.Duration;
import java.util.Arrays;

/** Samples for PatchSchedules CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/
     * RedisCachePatchSchedulesCreateOrUpdate.json
     */
    /**
     * Sample code: RedisCachePatchSchedulesCreateOrUpdate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCachePatchSchedulesCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getPatchSchedules().createOrUpdateWithResponse("rg1", "cache1",
            DefaultName.DEFAULT,
            new RedisPatchScheduleInner().withScheduleEntries(Arrays.asList(
                new ScheduleEntry().withDayOfWeek(DayOfWeek.MONDAY).withStartHourUtc(12)
                    .withMaintenanceWindow(Duration.parse("PT5H")),
                new ScheduleEntry().withDayOfWeek(DayOfWeek.TUESDAY).withStartHourUtc(12))),
            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.redis import RedisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redis
# USAGE
    python redis_cache_patch_schedules_create_or_update.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 = RedisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.patch_schedules.create_or_update(
        resource_group_name="rg1",
        name="cache1",
        default="default",
        parameters={
            "properties": {
                "scheduleEntries": [
                    {"dayOfWeek": "Monday", "maintenanceWindow": "PT5H", "startHourUtc": 12},
                    {"dayOfWeek": "Tuesday", "startHourUtc": 12},
                ]
            }
        },
    )
    print(response)


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesCreateOrUpdate.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 armredis_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/redis/armredis/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/20312e2b31df58f0ea7560e87062d62aa92f0a14/specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
func ExamplePatchSchedulesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredis.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPatchSchedulesClient().CreateOrUpdate(ctx, "rg1", "cache1", armredis.DefaultNameDefault, armredis.PatchSchedule{
		Properties: &armredis.ScheduleEntries{
			ScheduleEntries: []*armredis.ScheduleEntry{
				{
					DayOfWeek:         to.Ptr(armredis.DayOfWeekMonday),
					MaintenanceWindow: to.Ptr("PT5H"),
					StartHourUTC:      to.Ptr[int32](12),
				},
				{
					DayOfWeek:    to.Ptr(armredis.DayOfWeekTuesday),
					StartHourUTC: to.Ptr[int32](12),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.PatchSchedule = armredis.PatchSchedule{
	// 	Name: to.Ptr("cachename1/default"),
	// 	Type: to.Ptr("Microsoft.Cache/Redis/PatchSchedules"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armredis.ScheduleEntries{
	// 		ScheduleEntries: []*armredis.ScheduleEntry{
	// 			{
	// 				DayOfWeek: to.Ptr(armredis.DayOfWeekMonday),
	// 				MaintenanceWindow: to.Ptr("PT5H"),
	// 				StartHourUTC: to.Ptr[int32](12),
	// 			},
	// 			{
	// 				DayOfWeek: to.Ptr(armredis.DayOfWeekTuesday),
	// 				StartHourUTC: to.Ptr[int32](12),
	// 		}},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Create or replace the patching schedule for Redis cache.
 *
 * @summary Create or replace the patching schedule for Redis cache.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
 */
async function redisCachePatchSchedulesCreateOrUpdate() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rg1";
  const name = "cache1";
  const defaultParam = "default";
  const parameters = {
    scheduleEntries: [
      { dayOfWeek: "Monday", maintenanceWindow: "PT5H", startHourUtc: 12 },
      { dayOfWeek: "Tuesday", startHourUtc: 12 },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const result = await client.patchSchedules.createOrUpdate(
    resourceGroupName,
    name,
    defaultParam,
    parameters
  );
  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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Redis;
using Azure.ResourceManager.Redis.Models;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
// this example is just showing the usage of "PatchSchedules_CreateOrUpdate" 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 RedisResource created on azure
// for more information of creating RedisResource, please refer to the document of RedisResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string name = "cache1";
ResourceIdentifier redisResourceId = RedisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
RedisResource redis = client.GetRedisResource(redisResourceId);

// get the collection of this RedisPatchScheduleResource
RedisPatchScheduleCollection collection = redis.GetRedisPatchSchedules();

// invoke the operation
RedisPatchScheduleDefaultName defaultName = RedisPatchScheduleDefaultName.Default;
RedisPatchScheduleData data = new RedisPatchScheduleData(new RedisPatchScheduleSetting[]
{
new RedisPatchScheduleSetting(RedisDayOfWeek.Monday,12)
{
MaintenanceWindow = XmlConvert.ToTimeSpan("PT5H"),
},new RedisPatchScheduleSetting(RedisDayOfWeek.Tuesday,12)
});
ArmOperation<RedisPatchScheduleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, defaultName, data);
RedisPatchScheduleResource 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
RedisPatchScheduleData 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

Sample Response

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
  "location": "East US",
  "name": "cachename1/default",
  "type": "Microsoft.Cache/Redis/PatchSchedules",
  "properties": {
    "scheduleEntries": [
      {
        "dayOfWeek": "Monday",
        "startHourUtc": 12,
        "maintenanceWindow": "PT5H"
      },
      {
        "dayOfWeek": "Tuesday",
        "startHourUtc": 12
      }
    ]
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default",
  "location": "East US",
  "name": "cachename1/default",
  "type": "Microsoft.Cache/Redis/PatchSchedules",
  "properties": {
    "scheduleEntries": [
      {
        "dayOfWeek": "Monday",
        "startHourUtc": 12,
        "maintenanceWindow": "PT5H"
      },
      {
        "dayOfWeek": "Tuesday",
        "startHourUtc": 12
      }
    ]
  }
}

Definitionen

Name	Beschreibung
DayOfWeek	Wochentag, an dem ein Cache gepatcht werden kann.
defaultName	Standardzeichenfolge, die als Parameter modelliert wird, damit die automatische Generierung ordnungsgemäß funktioniert.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
RedisPatchSchedule	Antwort auf Put/Get-Patchzeitpläne für Redis Cache.
ScheduleEntry	Patchzeitplaneintrag für einen Redis-Premium-Cache.

DayOfWeek

Wochentag, an dem ein Cache gepatcht werden kann.

Name	Typ	Beschreibung
Everyday	string
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string
Weekend	string

defaultName

Standardzeichenfolge, die als Parameter modelliert wird, damit die automatische Generierung ordnungsgemäß funktioniert.

Name	Typ	Beschreibung
default	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

RedisPatchSchedule

Antwort auf Put/Get-Patchzeitpläne für Redis Cache.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.scheduleEntries	ScheduleEntry[]	Liste der Patchzeitpläne für einen Redis-Cache.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ScheduleEntry

Patchzeitplaneintrag für einen Redis-Premium-Cache.

Name	Typ	Beschreibung
dayOfWeek	DayOfWeek	Wochentag, an dem ein Cache gepatcht werden kann.
maintenanceWindow	string	ISO8601 Zeitspanne an, die angibt, wie viel Zeit das Patchen des Caches dauern kann.
startHourUtc	integer	Startstunde, nach der das Cachepatching beginnen kann.