Management Locks - Create Or Update By Scope

Dienst:

Resource Management

API-Version:

2016-09-01

Erstellen oder aktualisieren Sie eine Verwaltungssperre nach Bereich.

PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/locks/{lockName}?api-version=2016-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
lockName	path	True	string	Der Name der Sperre.
scope	path	True	string	Der Bereich für die Sperre. Verwenden Sie beim Bereitstellen eines Bereichs für die Zuordnung '/subscriptions/{subscriptionId}' für Abonnements, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für Ressourcengruppen und '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' für Ressourcen.
api-version	query	True	string	Die API-Version, die für den Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.level	True	LockLevel	Die Ebene der Sperre. Mögliche Werte sind: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete bedeutet, dass autorisierte Benutzer die Ressourcen lesen und ändern können, aber nicht löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen können, aber sie können sie nicht ändern oder löschen.
properties.notes		string	Hinweise zur Sperre. Maximal 512 Zeichen.
properties.owners		ManagementLockOwner[]	Die Besitzer der Sperre.

Antworten

Name	Typ	Beschreibung
200 OK	ManagementLockObject	OKAY
201 Created	ManagementLockObject	Erstellt

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ätswechsel ihres Benutzerkontos

Beispiele

Create management lock at scope

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Authorization/locks/testlock?api-version=2016-09-01

{
  "properties": {
    "level": "ReadOnly"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.resources.fluent.models.ManagementLockObjectInner;
import com.azure.resourcemanager.resources.models.LockLevel;

/** Samples for ManagementLocks CreateOrUpdateByScope. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtScope.json
     */
    /**
     * Sample code: Create management lock at scope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createManagementLockAtScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .createOrUpdateByScopeWithResponse(
                "subscriptions/subscriptionId",
                "testlock",
                new ManagementLockObjectInner().withLevel(LockLevel.READ_ONLY),
                Context.NONE);
    }
}

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.resource.locks import ManagementLockClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python management_locks_create_or_update_at_scope.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 = ManagementLockClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.management_locks.create_or_update_by_scope(
        scope="subscriptions/subscriptionId",
        lock_name="testlock",
        parameters={"properties": {"level": "ReadOnly"}},
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtScope.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

JavaScript

const { ManagementLockClient } = require("@azure/arm-locks-profile-2020-09-01-hybrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update a management lock by scope.
 *
 * @summary Create or update a management lock by scope.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtScope.json
 */
async function createManagementLockAtScope() {
  const subscriptionId =
    process.env["LOCKS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/subscriptionId";
  const lockName = "testlock";
  const parameters = { level: "ReadOnly" };
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const result = await client.managementLocks.createOrUpdateByScope(scope, lockName, 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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtScope.json
// this example is just showing the usage of "ManagementLocks_CreateOrUpdateByScope" 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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this ManagementLockResource
string scope = "subscriptions/subscriptionId";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
ManagementLockCollection collection = client.GetGenericResource(scopeId).GetManagementLocks();

// invoke the operation
string lockName = "testlock";
ManagementLockData data = new ManagementLockData(ManagementLockLevel.ReadOnly);
ArmOperation<ManagementLockResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, lockName, data);
ManagementLockResource 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
ManagementLockData 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

Beispiel für eine Antwort

Statuscode:

201

{
  "properties": {
    "level": "ReadOnly"
  },
  "id": "/providers/Microsoft.Authorization/locks/testlock",
  "type": "Microsoft.Authorization/locks",
  "name": "testlock"
}

Statuscode:

200

{
  "properties": {
    "level": "ReadOnly"
  },
  "id": "/providers/Microsoft.Authorization/locks/testlock",
  "type": "Microsoft.Authorization/locks",
  "name": "testlock"
}

Definitionen

Name	Beschreibung
LockLevel	Die Ebene der Sperre. Mögliche Werte sind: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete bedeutet, dass autorisierte Benutzer die Ressourcen lesen und ändern können, aber nicht löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen können, aber sie können sie nicht ändern oder löschen.
ManagementLockObject	Die Sperrinformationen.
ManagementLockOwner	Eigenschaften des Besitzers sperren.

LockLevel

Enumeration

Die Ebene der Sperre. Mögliche Werte sind: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete bedeutet, dass autorisierte Benutzer die Ressourcen lesen und ändern können, aber nicht löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen können, aber sie können sie nicht ändern oder löschen.

Wert	Beschreibung
CanNotDelete
NotSpecified
ReadOnly

ManagementLockObject

Objekt

Die Sperrinformationen.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Sperre.
name	string	Der Name der Sperre.
properties.level	LockLevel	Die Ebene der Sperre. Mögliche Werte sind: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete bedeutet, dass autorisierte Benutzer die Ressourcen lesen und ändern können, aber nicht löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen können, aber sie können sie nicht ändern oder löschen.
properties.notes	string	Hinweise zur Sperre. Maximal 512 Zeichen.
properties.owners	ManagementLockOwner[]	Die Besitzer der Sperre.
type	string	Der Ressourcentyp der Sperre – Microsoft.Authorization/Locks.

ManagementLockOwner

Objekt

Eigenschaften des Besitzers sperren.

Name	Typ	Beschreibung
applicationId	string	Die Anwendungs-ID des Sperrbesitzers.