Management Locks - Get At Resource Level

Dienst:

Resource Management

API-Version:

2016-09-01

Rufen Sie die Verwaltungssperre einer Ressource oder einer beliebigen Ebene unterhalb der Ressource ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/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.
parentResourcePath	path	True	string	Ein zusätzlicher Pfadparameter, der in einigen Diensten benötigt wird, z. B. SQL-Datenbanken.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. RegEx-Muster: ^[-\w\._\(\)]+$
resourceName	path	True	string	Der Name der Ressource.
resourceProviderNamespace	path	True	string	Der Namespace des Ressourcenanbieters.
resourceType	path	True	string	Der Typ der Ressource.
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.

Antworten

Name	Typ	Beschreibung
200 OK	ManagementLockObject	OK

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

Get management lock at resource level

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/resourcegroups/resourcegroupname/providers/Microsoft.Storage/parentResourcePath/storageAccounts/teststorageaccount/providers/Microsoft.Authorization/locks/testlock?api-version=2016-09-01

Java

import com.azure.core.util.Context;

/** Samples for ManagementLocks GetAtResourceLevel. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceLevel.json
     */
    /**
     * Sample code: Get management lock at resource level.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagementLockAtResourceLevel(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .getAtResourceLevelWithResponse(
                "resourcegroupname",
                "Microsoft.Storage",
                "parentResourcePath",
                "storageAccounts",
                "teststorageaccount",
                "testlock",
                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_get_at_resource_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.get_at_resource_level(
        resource_group_name="resourcegroupname",
        resource_provider_namespace="Microsoft.Storage",
        parent_resource_path="parentResourcePath",
        resource_type="storageAccounts",
        resource_name="teststorageaccount",
        lock_name="testlock",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceLevel.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 Get the management lock of a resource or any level below resource.
 *
 * @summary Get the management lock of a resource or any level below resource.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceLevel.json
 */
async function getManagementLockAtResourceLevel() {
  const subscriptionId = process.env["LOCKS_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["LOCKS_RESOURCE_GROUP"] || "resourcegroupname";
  const resourceProviderNamespace = "Microsoft.Storage";
  const parentResourcePath = "parentResourcePath";
  const resourceType = "storageAccounts";
  const resourceName = "teststorageaccount";
  const lockName = "testlock";
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const result = await client.managementLocks.getAtResourceLevel(
    resourceGroupName,
    resourceProviderNamespace,
    parentResourcePath,
    resourceType,
    resourceName,
    lockName
  );
  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

{
  "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.