Management Locks - Create Or Update At Resource Group Level

Dienst:

Resource Management

API-Version:

2016-09-01

Erstellt oder aktualisiert eine Verwaltungssperre auf Ressourcengruppenebene.
Wenn Sie eine Sperre in einem übergeordneten Bereich anwenden, erben alle untergeordneten Ressourcen diese Sperre. Zum Erstellen von Verwaltungssperren müssen Sie Zugriff auf Microsoft.Authorization/*- oder Microsoft.Authorization/locks/*-Aktionen haben. Unter den integrierten Rollen verfügen nur „Besitzer“ und „Benutzerzugriffsadministrator“ über diese Aktionen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
lockName	path	True	string	Der Sperrname. Der Sperrname darf maximal 260 Zeichen lang sein. Sie darf keine Steuerzeichen > enthalten<, %, &, :, , ? oder /.
resourceGroupName	path	True	string	Der Name der zu sperrenden Ressourcengruppe. RegEx-Muster: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
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 in der Lage sind, die Ressourcen zu lesen und zu ändern, aber nicht zu löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen, aber nicht ändern oder löschen können.
properties.notes		string	Hinweise zur Sperre. Maximal 512 Zeichen.
properties.owners		ManagementLockOwner[]	Die Besitzer der Sperre.

Antworten

Name	Typ	Beschreibung
200 OK	ManagementLockObject	OK: Gibt Informationen zur Sperre zurück.
201 Created	ManagementLockObject	Erstellt: Gibt Informationen zur Sperre zurück.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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 resource group level

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourcegroupname/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 CreateOrUpdateAtResourceGroupLevel. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtResourceGroupLevel.json
     */
    /**
     * Sample code: Create management lock at resource group level.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createManagementLockAtResourceGroupLevel(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .createOrUpdateAtResourceGroupLevelWithResponse(
                "resourcegroupname",
                "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 import ManagementLockClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python management_locks_create_or_update_at_resource_group_level.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="subscriptionId",
    )

    response = client.management_locks.create_or_update_at_resource_group_level(
        resource_group_name="resourcegroupname",
        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_CreateOrUpdateAtResourceGroupLevel.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 When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
 *
 * @summary When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_CreateOrUpdateAtResourceGroupLevel.json
 */
async function createManagementLockAtResourceGroupLevel() {
  const subscriptionId = process.env["LOCKS_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["LOCKS_RESOURCE_GROUP"] || "resourcegroupname";
  const lockName = "testlock";
  const parameters = { level: "ReadOnly" };
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const result = await client.managementLocks.createOrUpdateAtResourceGroupLevel(
    resourceGroupName,
    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

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 in der Lage sind, die Ressourcen zu lesen und zu ändern, aber nicht zu löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen, aber nicht ändern oder löschen können.
ManagementLockObject	Die Sperrinformationen.
ManagementLockOwner	Eigenschaften des Besitzers sperren.

LockLevel

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

Name	Typ	Beschreibung
CanNotDelete	string
NotSpecified	string
ReadOnly	string

ManagementLockObject

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 in der Lage sind, die Ressourcen zu lesen und zu ändern, aber nicht zu löschen. ReadOnly bedeutet, dass autorisierte Benutzer nur aus einer Ressource lesen, aber nicht ändern oder löschen können.
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

Eigenschaften des Besitzers sperren.

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