Resource Guards - Patch

Dienst:: Data Protection

API-Version:: 2024-04-01

Aktualisiert eine ResourceGuard-Ressource, die zu einer Ressourcengruppe gehört. Aktualisieren sie beispielsweise Tags für eine Ressource.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}?api-version=2024-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceGuardsName	path	True	string	Der Name von ResourceGuard
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
tags	object	Resource Guard-Tags.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceGuardResource	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	identitätswechseln Sie Ihr Benutzerkonto.

Beispiele

Patch ResourceGuard

Beispielanforderung

PATCH https://management.azure.com/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample?api-version=2024-04-01

{
  "tags": {
    "newKey": "newVal"
  }
}


import com.azure.resourcemanager.dataprotection.models.ResourceGuardResource;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ResourceGuards Patch.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/
     * ResourceGuardCRUD/PatchResourceGuard.json
     */
    /**
     * Sample code: Patch ResourceGuard.
     * 
     * @param manager Entry point to DataProtectionManager.
     */
    public static void patchResourceGuard(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        ResourceGuardResource resource = manager.resourceGuards()
            .getByResourceGroupWithResponse("SampleResourceGroup", "swaggerExample", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withTags(mapOf("newKey", "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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python patch_resource_guard.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 = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="0b352192-dcac-4cc7-992e-a96190ccc68c",
    )

    response = client.resource_guards.patch(
        resource_group_name="SampleResourceGroup",
        resource_guards_name="swaggerExample",
        parameters={"tags": {"newKey": "newVal"}},
    )
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/PatchResourceGuard.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 armdataprotection_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/dataprotection/armdataprotection/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
func ExampleResourceGuardsClient_Patch() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceGuardsClient().Patch(ctx, "SampleResourceGroup", "swaggerExample", armdataprotection.PatchResourceGuardInput{
		Tags: map[string]*string{
			"newKey": to.Ptr("newVal"),
		},
	}, 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.ResourceGuardResource = armdataprotection.ResourceGuardResource{
	// 	Name: to.Ptr("VaultGuardTestNew"),
	// 	Type: to.Ptr("Microsoft.DataProtection/resourceGuards"),
	// 	ID: to.Ptr("/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 		"TestKey": to.Ptr("TestValue"),
	// 	},
	// 	Properties: &armdataprotection.ResourceGuard{
	// 		Description: to.Ptr("Please take JIT access before performing any of the critical operation"),
	// 		AllowAutoApprovals: to.Ptr(true),
	// 		ProvisioningState: to.Ptr(armdataprotection.ProvisioningStateSucceeded),
	// 		ResourceGuardOperations: []*armdataprotection.ResourceGuardOperation{
	// 			{
	// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"),
	// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete"),
	// 			},
	// 			{
	// 				RequestResourceType: to.Ptr("Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"),
	// 				VaultCriticalOperation: to.Ptr("Microsoft.RecoveryServices/vaults/backupconfig/write"),
	// 		}},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.
 *
 * @summary Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2024-04-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
 */
async function patchResourceGuard() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "0b352192-dcac-4cc7-992e-a96190ccc68c";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "SampleResourceGroup";
  const resourceGuardsName = "swaggerExample";
  const parameters = { tags: { newKey: "newVal" } };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.resourceGuards.patch(
    resourceGroupName,
    resourceGuardsName,
    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

Beispiel für eine Antwort

Statuscode:: 200

{
  "location": "eastus",
  "tags": {
    "TestKey": "TestValue"
  },
  "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
  "name": "VaultGuardTestNew",
  "type": "Microsoft.DataProtection/resourceGuards",
  "properties": {
    "provisioningState": "Succeeded",
    "allowAutoApprovals": true,
    "resourceGuardOperations": [
      {
        "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
        "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
      },
      {
        "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
        "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
      }
    ],
    "description": "Please take JIT access before performing any of the critical operation"
  }
}

Definitionen

Name	Beschreibung
CloudError	CloudError
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Error	Die Fehlerantwort für die Ressourcenverwaltung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
PatchResourceGuardInput	PatchResourceGuardInput
ProvisioningState	Bereitstellungsstatus der BackupVault-Ressource
ResourceGuard
ResourceGuardOperation	Diese Klasse enthält alle Details zu einem kritischen Vorgang.
ResourceGuardResource
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

CloudError

Name	Typ	Beschreibung
error	Error	Die Fehlerantwort für die Ressourcenverwaltung.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Error

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	Error[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

PatchResourceGuardInput

Objekt

PatchResourceGuardInput

Name	Typ	Beschreibung
tags	object	Resource Guard-Tags.

ProvisioningState

Enumeration

Bereitstellungsstatus der BackupVault-Ressource

Wert	Beschreibung
Failed
Provisioning
Succeeded
Unknown
Updating

ResourceGuard

Objekt

Name	Typ	Beschreibung
allowAutoApprovals	boolean	Dieses Kennzeichen gibt an, ob die automatische Genehmigung zulässig ist.
description	string	Beschreibung der Vorqschritte zum Ausführen aller kritischen Vorgänge.
provisioningState	ProvisioningState	Bereitstellungsstatus der BackupVault-Ressource
resourceGuardOperations	ResourceGuardOperation[]	{readonly} Liste der Vorgangsdetails, die durch die ResourceGuard-Ressource geschützt sind
vaultCriticalOperationExclusionList	string[]	Liste der kritischen Vorgänge, die nicht durch diese resourceGuard geschützt sind

ResourceGuardOperation

Objekt

Diese Klasse enthält alle Details zu einem kritischen Vorgang.

Name	Typ	Beschreibung
requestResourceType	string	Typ der Ressourcenanforderung.
vaultCriticalOperation	string	Name des kritischen Vorgangs.

ResourceGuardResource

Objekt

Name	Typ	Beschreibung
eTag	string	Optionales ETag.
id	string	Die Ressourcen-ID stellt den vollständigen Pfad zur Ressource dar.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname, der der Ressource zugeordnet ist.
properties	ResourceGuard	ResourceGuardResource-Eigenschaften
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp stellt den vollständigen Pfad des Formulars Namespace/ResourceType/ResourceType/...

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Resource Guards - Patch

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Patch ResourceGuard

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

createdByType

Error

ErrorAdditionalInfo

PatchResourceGuardInput

ProvisioningState

ResourceGuard

ResourceGuardOperation

ResourceGuardResource

systemData