Garnet Clusters - Update

서비스:: Cosmos DB Resource Provider

API 버전:: 2025-11-01-preview

가넷 클러스터의 일부 속성을 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/garnetClusters/{clusterName}?api-version=2025-11-01-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	가넷클러스터리소스의 이름입니다
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties	GarnetClusterResourcePatchProperties	업데이트를 위한 Garnet 캐시 클러스터의 속성입니다.

응답

Name	형식	Description
200 OK	GarnetClusterResource	Azure 운영이 성공적으로 완료되었습니다.
202 Accepted		리소스 작업이 수락되었습니다. 헤더 Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

GarnetClusterResource

Azure 운영이 성공적으로 완료되었습니다.

202 Accepted

리소스 작업이 수락되었습니다.

헤더

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

CosmosDBGarnetClusterPatch

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/garnet-prod-rg/providers/Microsoft.DocumentDB/garnetClusters/garnet-prod?api-version=2025-11-01-preview

{
  "properties": {
    "clusterType": "Production"
  }
}

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

/**
 * This sample demonstrates how to updates some of the properties of a garnet cluster.
 *
 * @summary updates some of the properties of a garnet cluster.
 * x-ms-original-file: 2025-11-01-preview/CosmosDBGarnetClusterPatch.json
 */
async function cosmosDBGarnetClusterPatch() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.garnetClusters.update("garnet-prod-rg", "garnet-prod", {
    properties: { clusterType: "Production" },
  });
  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

샘플 응답

상태 코드:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2024-12-01-preview

상태 코드:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/garnet-prod-rg/providers/Microsoft.DocumentDB/garnetClusters/garnet-prod",
  "name": "garnet-prod",
  "type": "Microsoft.DocumentDB/garnetClusters",
  "location": "West US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management"
  }
}

정의

Name	Description
AllocationState	클러스터 및 데이터 센터 리소스의 할당 상태입니다.
ClusterType	클러스터의 유형입니다. 프로덕션으로 설정하면 클러스터에서 일부 작업이 허용되지 않을 수 있습니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답.
GarnetCacheProvisioningState	작업이 호출된 당시의 리소스 상태입니다.
GarnetClusterResource	가넷 캐시 클러스터의 표현입니다.
GarnetClusterResourcePatch	업데이트를 위한 Garnet 캐시 클러스터의 표현입니다.
GarnetClusterResourcePatchProperties	업데이트를 위한 Garnet 캐시 클러스터의 속성입니다.
GarnetClusterResourceProperties	Garnet 캐시 클러스터의 속성입니다.
GarnetClusterResourcePropertiesEndPointsItem	클라이언트가 클러스터에 연결할 수 있는 엔드포인트입니다.
ManagedCassandraManagedServiceIdentity	리소스의 ID입니다.
ManagedCassandraResourceIdentityType	리소스의 형식입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

AllocationState

열거형

클러스터 및 데이터 센터 리소스의 할당 상태입니다.

값	Description
Active	Active는 클러스터의 가상 머신이 할당된다는 의미입니다.
Deallocated	할당 해제는 가상 머신과 자원이 해제된다는 의미입니다.

ClusterType

열거형

클러스터의 유형입니다. 프로덕션으로 설정하면 클러스터에서 일부 작업이 허용되지 않을 수 있습니다.

값	Description
Production
NonProduction

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

오류 응답.

Name	형식	Description
code	string	오류 코드입니다.
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

GarnetCacheProvisioningState

열거형

작업이 호출된 당시의 리소스 상태입니다.

값	Description
Creating	만들기
Updating	업데이트 중
Deleting	삭제 중
Succeeded	성공함
Failed	실패
Canceled	취소됨

GarnetClusterResource

Object

가넷 캐시 클러스터의 표현입니다.

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedCassandraManagedServiceIdentity	리소스의 ID입니다.
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties	GarnetClusterResourceProperties	이 리소스에 대한 리소스별 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

GarnetClusterResourcePatch

Object

업데이트를 위한 Garnet 캐시 클러스터의 표현입니다.

Name	형식	Description
properties	GarnetClusterResourcePatchProperties	업데이트를 위한 Garnet 캐시 클러스터의 속성입니다.

GarnetClusterResourcePatchProperties

Object

업데이트를 위한 Garnet 캐시 클러스터의 속성입니다.

Name	형식	Description
clusterType	ClusterType	클러스터의 유형입니다. 프로덕션으로 설정하면 클러스터에서 일부 작업이 허용되지 않을 수 있습니다.
extensions	string[]	클러스터에서 추가 또는 업데이트할 확장입니다.

GarnetClusterResourceProperties

Object

Garnet 캐시 클러스터의 속성입니다.

Name	형식	Description
allocationState	AllocationState	클러스터 및 데이터 센터 리소스의 할당 상태입니다. 활성은 클러스터의 가상 머신이 할당되었음을 의미하고, 할당 취소는 가상 머신과 리소스가 할당 취소됨을 의미합니다.
availabilityZone	boolean	데이터 센터에 가용성 영역이 지원되는 경우 가넷 클러스터 가상 머신을 호스트하는 Virtual Machine ScaleSet에 적용합니다.
clusterType	ClusterType	클러스터의 유형입니다. 프로덕션으로 설정하면 클러스터에서 일부 작업이 허용되지 않을 수 있습니다.
endPoints	GarnetClusterResourcePropertiesEndPointsItem[]	클라이언트가 클러스터에 연결할 수 있는 엔드포인트입니다.
extensions	string[]	클러스터에서 추가 또는 업데이트할 확장입니다.
nodeCount	integer (int32)	노드 수입니다.
nodeSku	string	클러스터에 사용되는 Virtual Machine SKU입니다. 기본 값은 Standard_DS14_v2입니다.
provisionError	ErrorDetail	리소스 프로비저닝과 관련된 오류입니다.
provisioningState	GarnetCacheProvisioningState	리소스의 프로비전 상태입니다.
replicationFactor	integer (int32)	클러스터가 유지하는 데이터 복사본 수.
subnetId	string (arm-id)	이 클러스터의 관리 서비스에 연결된 네트워크 인터페이스가 있어야 하는 서브넷의 리소스 ID입니다. 서브넷은 데이터 센터에 위임될 모든 서브넷으로 라우팅할 수 있어야 합니다. 리소스 ID는 '/subscriptions/<구독 ID>/resourceGroups/<리소스 그룹>/providers/Microsoft.Network/virtualNetworks/<가상 네트워크>/subnets/<서브넷>형식이어야 합니다.

GarnetClusterResourcePropertiesEndPointsItem

Object

클라이언트가 클러스터에 연결할 수 있는 엔드포인트입니다.

Name	형식	Description
ipAddress	string	엔드포인트의 IPv4 주소.
port	integer (int32)	포트 번호입니다.

ManagedCassandraManagedServiceIdentity

Object

리소스의 ID입니다.

Name	형식	Description
principalId	string	ID 리소스의 개체 ID입니다.
tenantId	string	리소스의 테넌트 ID입니다.
type	ManagedCassandraResourceIdentityType	리소스의 형식입니다.

ManagedCassandraResourceIdentityType

열거형

리소스의 형식입니다.

값	Description
SystemAssigned
None

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.