SAP Database Instances - Update

서비스:

Workloads

API 버전:

2023-04-01

데이터베이스 리소스를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}?api-version=2023-04-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
databaseInstanceName	path	True	string	자동 생성이 제대로 작동하도록 매개 변수로 모델링된 데이터베이스 리소스 이름 문자열입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
sapVirtualInstanceName	path	True	string	SAP 솔루션 리소스에 대한 Virtual Instances의 이름
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
tags	object	리소스 태그를 가져오거나 설정합니다.

응답

Name	형식	Description
200 OK	SAPDatabaseInstance	SAP 시스템의 데이터베이스 리소스에 대해 설명합니다.
201 Created	SAPDatabaseInstance	SAP 시스템의 데이터베이스 리소스에 대해 설명합니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

SAPDatabaseInstances_Update

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer?api-version=2023-04-01

{
  "tags": {
    "key1": "value1"
  }
}

Java

import com.azure.resourcemanager.workloads.models.SapDatabaseInstance;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for SapDatabaseInstances Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/
     * SAPDatabaseInstances_Update.json
     */
    /**
     * Sample code: SAPDatabaseInstances_Update.
     * 
     * @param manager Entry point to WorkloadsManager.
     */
    public static void sAPDatabaseInstancesUpdate(com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        SapDatabaseInstance resource = manager.sapDatabaseInstances()
            .getWithResponse("test-rg", "X00", "databaseServer", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("key1", "fakeTokenPlaceholder")).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.workloads import WorkloadsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-workloads
# USAGE
    python sap_database_instances_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 = WorkloadsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="6d875e77-e412-4d7d-9af4-8895278b4443",
    )

    response = client.sap_database_instances.begin_update(
        resource_group_name="test-rg",
        sap_virtual_instance_name="X00",
        database_instance_name="databaseServer",
    ).result()
    print(response)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPDatabaseInstances_Update.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 armworkloads_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/workloads/armworkloads"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPDatabaseInstances_Update.json
func ExampleSAPDatabaseInstancesClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armworkloads.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSAPDatabaseInstancesClient().BeginUpdate(ctx, "test-rg", "X00", "databaseServer", armworkloads.UpdateSAPDatabaseInstanceRequest{
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
	}, 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.SAPDatabaseInstance = armworkloads.SAPDatabaseInstance{
	// 	Name: to.Ptr("databaseServer"),
	// 	Type: to.Ptr("Microsoft.Workloads/sapVirtualInstances/databaseInstances"),
	// 	ID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer"),
	// 	SystemData: &armworkloads.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
	// 		CreatedBy: to.Ptr("user@xyz.com"),
	// 		CreatedByType: to.Ptr(armworkloads.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user@xyz.com"),
	// 		LastModifiedByType: to.Ptr(armworkloads.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westcentralus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armworkloads.SAPDatabaseProperties{
	// 		DatabaseSid: to.Ptr("X00"),
	// 		DatabaseType: to.Ptr("hdb"),
	// 		IPAddress: to.Ptr("10.0.0.5"),
	// 		ProvisioningState: to.Ptr(armworkloads.SapVirtualInstanceProvisioningStateSucceeded),
	// 		Status: to.Ptr(armworkloads.SAPVirtualInstanceStatusRunning),
	// 		Subnet: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 		VMDetails: []*armworkloads.DatabaseVMDetails{
	// 			{
	// 				VirtualMachineID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm"),
	// 		}},
	// 	},
	// }
}

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 { WorkloadsClient } = require("@azure/arm-workloads");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the Database resource.
 *
 * @summary Updates the Database resource.
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPDatabaseInstances_Update.json
 */
async function sapDatabaseInstancesUpdate() {
  const subscriptionId =
    process.env["WORKLOADS_SUBSCRIPTION_ID"] || "6d875e77-e412-4d7d-9af4-8895278b4443";
  const resourceGroupName = process.env["WORKLOADS_RESOURCE_GROUP"] || "test-rg";
  const sapVirtualInstanceName = "X00";
  const databaseInstanceName = "databaseServer";
  const body = { tags: { key1: "value1" } };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const result = await client.sAPDatabaseInstances.beginUpdateAndWait(
    resourceGroupName,
    sapVirtualInstanceName,
    databaseInstanceName,
    options
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Workloads.Models;
using Azure.ResourceManager.Workloads;

// Generated from example definition: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPDatabaseInstances_Update.json
// this example is just showing the usage of "SAPDatabaseInstances_Update" 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 SapDatabaseInstanceResource created on azure
// for more information of creating SapDatabaseInstanceResource, please refer to the document of SapDatabaseInstanceResource
string subscriptionId = "6d875e77-e412-4d7d-9af4-8895278b4443";
string resourceGroupName = "test-rg";
string sapVirtualInstanceName = "X00";
string databaseInstanceName = "databaseServer";
ResourceIdentifier sapDatabaseInstanceResourceId = SapDatabaseInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, sapVirtualInstanceName, databaseInstanceName);
SapDatabaseInstanceResource sapDatabaseInstance = client.GetSapDatabaseInstanceResource(sapDatabaseInstanceResourceId);

// invoke the operation
SapDatabaseInstancePatch patch = new SapDatabaseInstancePatch
{
    Tags =
    {
    ["key1"] = "value1"
    },
};
ArmOperation<SapDatabaseInstanceResource> lro = await sapDatabaseInstance.UpdateAsync(WaitUntil.Completed, patch);
SapDatabaseInstanceResource 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
SapDatabaseInstanceData 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

샘플 응답

상태 코드:

201

{
  "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer",
  "name": "databaseServer",
  "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances",
  "tags": {
    "key1": "value1"
  },
  "location": "westcentralus",
  "systemData": {
    "createdBy": "user@xyz.com",
    "createdByType": "User",
    "createdAt": "2021-08-19T15:10:46.196Z",
    "lastModifiedBy": "user@xyz.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-19T15:10:46.196Z"
  },
  "properties": {
    "databaseSid": "X00",
    "databaseType": "hdb",
    "ipAddress": "10.0.0.5",
    "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "vmDetails": [
      {
        "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm"
      }
    ],
    "status": "Running",
    "errors": null,
    "provisioningState": "Succeeded"
  }
}

상태 코드:

200

{
  "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00/databaseInstances/databaseServer",
  "name": "databaseServer",
  "type": "Microsoft.Workloads/sapVirtualInstances/databaseInstances",
  "tags": {},
  "location": "westcentralus",
  "systemData": {
    "createdBy": "user@xyz.com",
    "createdByType": "User",
    "createdAt": "2021-08-19T15:10:46.196Z",
    "lastModifiedBy": "user@xyz.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-19T15:10:46.196Z"
  },
  "properties": {
    "databaseSid": "X00",
    "databaseType": "hdb",
    "ipAddress": "10.0.0.5",
    "subnet": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "vmDetails": [
      {
        "virtualMachineId": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Compute/virtualMachines/db-vm"
      }
    ],
    "status": "Running",
    "errors": null,
    "provisioningState": "Succeeded"
  }
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
DatabaseVmDetails	데이터베이스 VM 세부 정보입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDefinition	오류 정의입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
LoadBalancerDetails	Load Balancer ID와 같은 Load Balancer 세부 정보입니다.
SAPDatabaseInstance	데이터베이스 리소스를 정의합니다.
SAPVirtualInstanceError	SAP 워크로드 서비스용 Virtual Instance의 오류 응답입니다.
SapVirtualInstanceProvisioningState	프로비저닝 상태를 정의합니다.
SAPVirtualInstanceStatus	SAP 인스턴스 상태를 정의합니다.
StorageInformation	VM에 연결된 모든 Storage 계정의 스토리지 세부 정보입니다. 예를 들어 AFS 공유 스토리지의 NFS입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UpdateSAPDatabaseInstanceRequest	SAP Database Instance를 업데이트하기 위한 요청 본문을 정의합니다.

createdByType

열거형

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

값	Description
User
Application
ManagedIdentity
Key

DatabaseVmDetails

Object

데이터베이스 VM 세부 정보입니다.

Name	형식	Description
status	SAPVirtualInstanceStatus	SAP 인스턴스 상태를 정의합니다.
storageDetails	StorageInformation[]	데이터베이스 가상 머신에 연결된 모든 스토리지 계정의 스토리지 세부 정보입니다. 예를 들어 AFS 공유 스토리지의 NFS입니다.
virtualMachineId	string

ErrorAdditionalInfo

Object

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

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

ErrorDefinition

Object

오류 정의입니다.

Name	형식	Description
code	string	HTTP 오류 코드의 하위 상태 역할을 하는 서비스별 오류 코드입니다.
details	ErrorDefinition[]	내부 오류 세부 정보입니다.
message	string	오류에 대한 설명입니다.

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

LoadBalancerDetails

Object

Load Balancer ID와 같은 Load Balancer 세부 정보입니다.

Name	형식	Description
id	string

SAPDatabaseInstance

Object

데이터베이스 리소스를 정의합니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.databaseSid	string	데이터베이스 SID 이름입니다.
properties.databaseType	string	데이터베이스 유형, 즉 DB가 HANA, DB2, Oracle, SAP ASE, Max DB 또는 MS SQL Server인 경우입니다.
properties.errors	SAPVirtualInstanceError	데이터베이스 리소스와 관련된 오류를 정의합니다.
properties.ipAddress	string	데이터베이스 IP 주소입니다.
properties.loadBalancerDetails	LoadBalancerDetails	데이터베이스 Virtual Machines에 연결된 LoadBalancer ID와 같은 Load Balancer 세부 정보
properties.provisioningState	SapVirtualInstanceProvisioningState	프로비저닝 상태를 정의합니다.
properties.status	SAPVirtualInstanceStatus	SAP 인스턴스 상태를 정의합니다.
properties.subnet	string	데이터베이스 서브넷.
properties.vmDetails	DatabaseVmDetails[]	데이터베이스 리소스에 해당하는 가상 머신의 목록입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

SAPVirtualInstanceError

Object

SAP 워크로드 서비스용 Virtual Instance의 오류 응답입니다.

Name	형식	Description
properties	ErrorDefinition	SAP용 Virtual Instance 오류 본문입니다.

SapVirtualInstanceProvisioningState

열거형

프로비저닝 상태를 정의합니다.

값	Description
Succeeded
Updating
Creating
Failed
Deleting

SAPVirtualInstanceStatus

열거형

SAP 인스턴스 상태를 정의합니다.

값	Description
Starting
Running
Stopping
Offline
PartiallyRunning
Unavailable
SoftShutdown

StorageInformation

Object

VM에 연결된 모든 Storage 계정의 스토리지 세부 정보입니다. 예를 들어 AFS 공유 스토리지의 NFS입니다.

Name	형식	Description
id	string

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의 형식입니다.

UpdateSAPDatabaseInstanceRequest

Object

SAP Database Instance를 업데이트하기 위한 요청 본문을 정의합니다.

Name	형식	Description
tags	object	리소스 태그를 가져오거나 설정합니다.