Resource Guards - Patch

Usługa:: Data Protection

Wersja interfejsu API:: 2024-04-01

Aktualizuje zasób ResourceGuard należący do grupy zasobów. Na przykład aktualizowanie tagów zasobu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
resourceGuardsName	path	True	string	Nazwa usługi ResourceGuard
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
tags	object	Tagi funkcji Resource Guard.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceGuardResource	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikuj konto użytkownika.

Przykłady

Patch ResourceGuard

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
CloudError	CloudError
createdByType	Typ tożsamości, która utworzyła zasób.
Error	Odpowiedź na błąd zarządzania zasobami.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
PatchResourceGuardInput	PatchResourceGuardInput
ProvisioningState	Stan aprowizacji zasobu BackupVault
ResourceGuard
ResourceGuardOperation	Ta klasa zawiera wszystkie szczegóły dotyczące operacji krytycznej.
ResourceGuardResource
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Objekt

CloudError

Nazwa	Typ	Opis
error	Error	Odpowiedź na błąd zarządzania zasobami.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

Error

Objekt

Odpowiedź na błąd zarządzania zasobami.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	Error[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

PatchResourceGuardInput

Objekt

PatchResourceGuardInput

Nazwa	Typ	Opis
tags	object	Tagi funkcji Resource Guard.

ProvisioningState

Wyliczanie

Stan aprowizacji zasobu BackupVault

Wartość	Opis
Failed
Provisioning
Succeeded
Unknown
Updating

ResourceGuard

Objekt

Nazwa	Typ	Opis
allowAutoApprovals	boolean	Ta flaga wskazuje, czy automatyczne zatwierdzanie jest dozwolone, czy nie.
description	string	Opis kroków poprzedzających wykonywanie wszystkich operacji krytycznych.
provisioningState	ProvisioningState	Stan aprowizacji zasobu BackupVault
resourceGuardOperations	ResourceGuardOperation[]	{readonly} Lista szczegółów operacji, które są chronione przez zasób ResourceGuard
vaultCriticalOperationExclusionList	string[]	Lista operacji krytycznych, które nie są chronione przez tę funkcję resourceGuard

ResourceGuardOperation

Objekt

Ta klasa zawiera wszystkie szczegóły dotyczące operacji krytycznej.

Nazwa	Typ	Opis
requestResourceType	string	Typ żądania zasobu.
vaultCriticalOperation	string	Nazwa operacji krytycznej.

ResourceGuardResource

Objekt

Nazwa	Typ	Opis
eTag	string	Opcjonalny element ETag.
id	string	Identyfikator zasobu reprezentuje pełną ścieżkę do zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu skojarzona z zasobem.
properties	ResourceGuard	Właściwości resourceGuardResource
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu reprezentuje pełną ścieżkę formularza Namespace/ResourceType/ResourceType/...

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Resource Guards - Patch

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Patch ResourceGuard

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

createdByType

Error

ErrorAdditionalInfo

PatchResourceGuardInput

ProvisioningState

ResourceGuard

ResourceGuardOperation

ResourceGuardResource

systemData