Management Locks - Create Or Update At Resource Group Level

Service:

Resource Management

API Version:

2016-09-01

Cria ou atualiza um bloqueio de gestão ao nível do grupo de recursos.
Quando aplica um bloqueio num âmbito principal, todos os recursos subordinados herdam o mesmo bloqueio. Para criar bloqueios de gestão, tem de ter acesso às ações Microsoft.Authorization/* ou Microsoft.Authorization/locks/*. Das funções incorporadas, apenas Proprietário e Administrador de Acesso dos Utilizadores têm acesso a essas ações.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
lockName	path	True	string	O nome do bloqueio. O nome de bloqueio pode ter um máximo de 260 carateres. Não pode conter <, > %, &, :, , ?, /, ou quaisquer carateres de controlo.
resourceGroupName	path	True	string	O nome do grupo de recursos a bloquear. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para a operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.level	True	LockLevel	O nível do cadeado. Os valores possíveis são: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete significa que os utilizadores autorizados podem ler e modificar os recursos, mas não eliminar. ReadOnly significa que os utilizadores autorizados só podem ler a partir de um recurso, mas não podem modificá-lo ou eliminá-lo.
properties.notes		string	Notas sobre o bloqueio. Máximo de 512 carateres.
properties.owners		ManagementLockOwner[]	Os proprietários da fechadura.

Respostas

Name	Tipo	Description
200 OK	ManagementLockObject	OK - Devolve informações sobre o bloqueio.
201 Created	ManagementLockObject	Criado – devolve informações sobre o bloqueio.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create management lock at resource group level

Sample Request

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 typing import Any, IO, Union

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

Sample Response

Status code:

201

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

Status code:

200

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

Definições

Name	Description
LockLevel	O nível do cadeado. Os valores possíveis são: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete significa que os utilizadores autorizados podem ler e modificar os recursos, mas não eliminar. ReadOnly significa que os utilizadores autorizados só podem ler a partir de um recurso, mas não podem modificá-lo ou eliminá-lo.
ManagementLockObject	As informações de bloqueio.
ManagementLockOwner	Bloquear propriedades do proprietário.

LockLevel

O nível do cadeado. Os valores possíveis são: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete significa que os utilizadores autorizados podem ler e modificar os recursos, mas não eliminar. ReadOnly significa que os utilizadores autorizados só podem ler a partir de um recurso, mas não podem modificá-lo ou eliminá-lo.

Name	Tipo	Description
CanNotDelete	string
NotSpecified	string
ReadOnly	string

ManagementLockObject

As informações de bloqueio.

Name	Tipo	Description
id	string	O ID de recurso do bloqueio.
name	string	O nome do bloqueio.
properties.level	LockLevel	O nível do cadeado. Os valores possíveis são: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete significa que os utilizadores autorizados podem ler e modificar os recursos, mas não eliminar. ReadOnly significa que os utilizadores autorizados só podem ler a partir de um recurso, mas não podem modificá-lo ou eliminá-lo.
properties.notes	string	Notas sobre o bloqueio. Máximo de 512 carateres.
properties.owners	ManagementLockOwner[]	Os proprietários da fechadura.
type	string	O tipo de recurso do bloqueio – Microsoft.Authorization/locks.

ManagementLockOwner

Bloquear propriedades do proprietário.

Name	Tipo	Description
applicationId	string	O ID da aplicação do proprietário do bloqueio.