Management Locks - List By Scope

リファレンス

Service:: Resource Management

API Version:: 2016-09-01

スコープのすべての管理ロックを取得します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	ロックのスコープ。割り当てのスコープを指定する場合は、サブスクリプションに '/subscriptions/{subscriptionId}' を使用し、リソースグループには '/subscriptions/{subscriptionId}/{resourceGroupName}' を、リソースには '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' を使用します。
api-version	query	True	string	操作に使用する API バージョン。
$filter	query		string	操作に適用するフィルター。

応答

名前	型	説明
200 OK	ManagementLockListResult	OK - リソースロックの配列を返します。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

List management locks at scope

Sample Request

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

import com.azure.core.util.Context;

/** Samples for ManagementLocks ListByScope. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_ListAtScope.json
     */
    /**
     * Sample code: List management locks at scope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagementLocksAtScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .listByScope("subscriptions/subscriptionId", 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

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_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.list_by_scope(
        scope="subscriptions/subscriptionId",
    )
    for item in response:
        print(item)


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

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 scope.
 *
 * @summary Gets all the management locks for a scope.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_ListAtScope.json
 */
async function listManagementLocksAtScope() {
  const subscriptionId =
    process.env["LOCKS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/subscriptionId";
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.managementLocks.listByScope(scope)) {
    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

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_ListAtScope.json
// this example is just showing the usage of "ManagementLocks_ListByScope" 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 and iterate over the result
await foreach (ManagementLockResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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:: 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	ロックのリソース ID。
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	ロック所有者のアプリケーション ID。

Management Locks - List By Scope

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

List management locks at scope

Sample Request

Sample Response

定義

LockLevel

ManagementLockListResult

ManagementLockObject

ManagementLockOwner

その他のリソース