Management Locks - List At Resource Group Level

Служба:

Resource Management

Версия API:

2016-09-01

Получает все блокировки управления для группы ресурсов.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей блокировки для получения. Шаблон регулярного выражения: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для операции.
$filter	query		string	Фильтр, применяемый к операции.

Ответы

Имя	Тип	Описание
200 OK	ManagementLockListResult	ОК. Возвращает массив блокировок ресурсов.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List management groups at resource group level

Образец запроса

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ManagementLocks ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_ListAtResourceGroupLevel.json
     */
    /**
     * Sample code: List management groups at resource group level.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagementGroupsAtResourceGroupLevel(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .listByResourceGroup("resourcegroupname", null, 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_list_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.list_at_resource_group_level(
        resource_group_name="resourcegroupname",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_ListAtResourceGroupLevel.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 Gets all the management locks for a resource group.
 *
 * @summary Gets all the management locks for a resource group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_ListAtResourceGroupLevel.json
 */
async function listManagementGroupsAtResourceGroupLevel() {
  const subscriptionId = process.env["LOCKS_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["LOCKS_RESOURCE_GROUP"] || "resourcegroupname";
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.managementLocks.listAtResourceGroupLevel(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Пример ответа

Код состояния:

200

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

Определения

Имя	Описание
LockLevel	Уровень блокировки. Возможные значения: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete означает, что авторизованные пользователи могут читать и изменять ресурсы, но не удалять. ReadOnly означает, что авторизованные пользователи могут только считывать данные из ресурса, но не могут изменять или удалять его.
ManagementLockListResult	Список блокировок.
ManagementLockObject	Сведения о блокировке.
ManagementLockOwner	Блокировка свойств владельца.

LockLevel

Уровень блокировки. Возможные значения: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete означает, что авторизованные пользователи могут читать и изменять ресурсы, но не удалять. ReadOnly означает, что авторизованные пользователи могут только считывать данные из ресурса, но не могут изменять или удалять его.

Имя	Тип	Описание
CanNotDelete	string
NotSpecified	string
ReadOnly	string

ManagementLockListResult

Список блокировок.

Имя	Тип	Описание
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	ManagementLockObject[]	Список блокировок.

ManagementLockObject

Сведения о блокировке.

Имя	Тип	Описание
id	string	Идентификатор ресурса блокировки.
name	string	Имя блокировки.
properties.level	LockLevel	Уровень блокировки. Возможные значения: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete означает, что авторизованные пользователи могут читать и изменять ресурсы, но не удалять. ReadOnly означает, что авторизованные пользователи могут только считывать данные из ресурса, но не могут изменять или удалять его.
properties.notes	string	Примечания о блокировке. Не более 512 символов.
properties.owners	ManagementLockOwner[]	Владельцы блокировки.
type	string	Тип ресурса блокировки — Microsoft.Authorization/locks.

ManagementLockOwner

Блокировка свойств владельца.

Имя	Тип	Описание
applicationId	string	Идентификатор приложения владельца блокировки.