Patch Schedules - Get

Service:

Redis Cache

API Version:

2023-08-01

redis 캐시의 패치 일정을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
default	path	True	defaultName	자동 생성이 올바르게 작동하도록 매개 변수로 모델링된 기본 문자열입니다.
name	path	True	string	redis 캐시의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	RedisPatchSchedule	패치 일정 가져오기에 대한 응답입니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

RedisCachePatchSchedulesGet

Sample Request

HTTP

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

Java

import com.azure.resourcemanager.redis.models.DefaultName;

/** Samples for PatchSchedules Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesGet.json
     */
    /**
     * Sample code: RedisCachePatchSchedulesGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCachePatchSchedulesGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getPatchSchedules().getWithResponse("rg1", "cache1",
            DefaultName.DEFAULT, 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

Python

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_get.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.get(
        resource_group_name="rg1",
        name="cache1",
        default="default",
    )
    print(response)


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesGet.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

Go

package armredis_test

import (
	"context"
	"log"

	"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/RedisCachePatchSchedulesGet.json
func ExamplePatchSchedulesClient_Get() {
	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().Get(ctx, "rg1", "cache1", armredis.DefaultNameDefault, 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("cache1/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

JavaScript

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

/**
 * This sample demonstrates how to Gets the patching schedule of a redis cache.
 *
 * @summary Gets the patching schedule of a redis cache.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCachePatchSchedulesGet.json
 */
async function redisCachePatchSchedulesGet() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rg1";
  const name = "cache1";
  const defaultParam = "default";
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const result = await client.patchSchedules.get(resourceGroupName, name, defaultParam);
  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

dotnet

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/RedisCachePatchSchedulesGet.json
// this example is just showing the usage of "PatchSchedules_Get" 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;
NullableResponse<RedisPatchScheduleResource> response = await collection.GetIfExistsAsync(defaultName);
RedisPatchScheduleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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:

200

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

정의

Name	Description
DayOfWeek	캐시를 패치할 수 있는 요일입니다.
defaultName	자동 생성이 올바르게 작동하도록 매개 변수로 모델링된 기본 문자열입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
RedisPatchSchedule	Redis 캐시에 대한 패치 일정을 배치/가져오기 위한 응답입니다.
ScheduleEntry	프리미엄 Redis Cache에 대한 패치 일정 항목입니다.

DayOfWeek

캐시를 패치할 수 있는 요일입니다.

Name	형식	Description
Everyday	string
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string
Weekend	string

defaultName

자동 생성이 올바르게 작동하도록 매개 변수로 모델링된 기본 문자열입니다.

Name	형식	Description
default	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

RedisPatchSchedule

Redis 캐시에 대한 패치 일정을 배치/가져오기 위한 응답입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름입니다.
properties.scheduleEntries	ScheduleEntry[]	Redis 캐시에 대한 패치 일정 목록입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ScheduleEntry

프리미엄 Redis Cache에 대한 패치 일정 항목입니다.

Name	형식	Description
dayOfWeek	DayOfWeek	캐시를 패치할 수 있는 요일입니다.
maintenanceWindow	string	캐시 패치에 소요할 수 있는 시간을 지정하는 시간 범위를 ISO8601.
startHourUtc	integer	캐시 패치를 시작할 수 있는 시간 후에 시작합니다.