SAP Database Instances - Update

Služba:

Workloads

Verze rozhraní API:

2023-04-01

Aktualizuje prostředek databáze.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseInstanceName	path	True	string	Řetězec názvu databázového prostředku modelovaný jako parametr pro správné generování automatického generování.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
sapVirtualInstanceName	path	True	string	Název prostředku virtuálních instancí pro řešení SAP
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
tags	object	Získá nebo nastaví značky prostředků.

Odpovědi

Name	Typ	Description
200 OK	SAPDatabaseInstance	Popisuje databázový prostředek systému SAP.
201 Created	SAPDatabaseInstance	Popisuje databázový prostředek systému SAP.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SAPDatabaseInstances_Update

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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"
  }
}

Stavový kód:

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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
DatabaseVmDetails	Podrobnosti o databázovém virtuálním počítači
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDefinition	Definice chyby
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
LoadBalancerDetails	Podrobnosti nástroje pro vyrovnávání zatížení, jako je ID Load Balanceru.
SAPDatabaseInstance	Definujte prostředek databáze.
SAPVirtualInstanceError	Odpověď na chybu z virtuální instance pro službu úloh SAP
SapVirtualInstanceProvisioningState	Definuje stavy zřizování.
SAPVirtualInstanceStatus	Definuje stav instance SAP.
StorageInformation	Podrobnosti o úložišti všech účtů úložiště připojených k virtuálnímu počítači Například systém souborů NFS ve sdíleném úložišti AFS.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UpdateSAPDatabaseInstanceRequest	Definuje text požadavku pro aktualizaci instance databáze SAP.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DatabaseVmDetails

Objekt

Podrobnosti o databázovém virtuálním počítači

Name	Typ	Description
status	SAPVirtualInstanceStatus	Definuje stav instance SAP.
storageDetails	StorageInformation[]	Podrobnosti o úložišti všech účtů úložiště připojených k databázovému virtuálnímu počítači Například systém souborů NFS ve sdíleném úložišti AFS.
virtualMachineId	string

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDefinition

Objekt

Definice chyby

Name	Typ	Description
code	string	Kód chyby specifický pro službu, který slouží jako dílčí stav kódu chyby HTTP.
details	ErrorDefinition[]	Podrobnosti o vnitřní chybě.
message	string	Popis chyby

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LoadBalancerDetails

Objekt

Podrobnosti nástroje pro vyrovnávání zatížení, jako je ID Load Balanceru.

Name	Typ	Description
id	string

SAPDatabaseInstance

Objekt

Definujte prostředek databáze.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.databaseSid	string	Název IDENTIFIKÁTORU SID databáze.
properties.databaseType	string	Typ databáze, to znamená, že databáze je HANA, DB2, Oracle, SAP ASE, Max DB nebo MS SQL Server.
properties.errors	SAPVirtualInstanceError	Definuje chyby související s databázovým prostředkem.
properties.ipAddress	string	IP adresa databáze.
properties.loadBalancerDetails	LoadBalancerDetails	Podrobnosti nástroje pro vyrovnávání zatížení, jako je ID LoadBalanceru připojené k databázovým virtuálním počítačům
properties.provisioningState	SapVirtualInstanceProvisioningState	Definuje stavy zřizování.
properties.status	SAPVirtualInstanceStatus	Definuje stav instance SAP.
properties.subnet	string	Podsíť databáze.
properties.vmDetails	DatabaseVmDetails[]	Seznam virtuálních počítačů odpovídajících prostředku databáze.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SAPVirtualInstanceError

Objekt

Odpověď na chybu z virtuální instance pro službu úloh SAP

Name	Typ	Description
properties	ErrorDefinition	Virtuální instance pro text chyby SAP.

SapVirtualInstanceProvisioningState

Výčet

Definuje stavy zřizování.

Hodnota	Description
Succeeded
Updating
Creating
Failed
Deleting

SAPVirtualInstanceStatus

Výčet

Definuje stav instance SAP.

Hodnota	Description
Starting
Running
Stopping
Offline
PartiallyRunning
Unavailable
SoftShutdown

StorageInformation

Objekt

Podrobnosti o úložišti všech účtů úložiště připojených k virtuálnímu počítači Například systém souborů NFS ve sdíleném úložišti AFS.

Name	Typ	Description
id	string

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UpdateSAPDatabaseInstanceRequest

Objekt

Definuje text požadavku pro aktualizaci instance databáze SAP.

Name	Typ	Description
tags	object	Získá nebo nastaví značky prostředků.