Management Locks - Get At Resource Group Level

Service:

Resource Management

API Version:

2016-09-01

リソース グループ レベルで管理ロックを取得します。

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

URI パラメーター

名前	/	必須	型	説明
lockName	path	True	string	取得するロックの名前。
resourceGroupName	path	True	string	ロックされたリソース グループの名前。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ManagementLockObject	OK - ロックに関する情報を返します。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

例

Get management lock at resource group level

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ManagementLocks GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceGroupLevel.json
     */
    /**
     * Sample code: Get management lock at resource group level.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getManagementLockAtResourceGroupLevel(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .genericResources()
            .manager()
            .managementLockClient()
            .getManagementLocks()
            .getByResourceGroupWithResponse("resourcegroupname", "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_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.get_at_resource_group_level(
        resource_group_name="resourcegroupname",
        lock_name="testlock",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceGroupLevel.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 a management lock at the resource group level.
 *
 * @summary Gets a management lock at the resource group level.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtResourceGroupLevel.json
 */
async function getManagementLockAtResourceGroupLevel() {
  const subscriptionId = process.env["LOCKS_SUBSCRIPTION_ID"] || "subscriptionId";
  const resourceGroupName = process.env["LOCKS_RESOURCE_GROUP"] || "resourcegroupname";
  const lockName = "testlock";
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const result = await client.managementLocks.getAtResourceGroupLevel(resourceGroupName, 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

Sample Response

Status code:

200

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

定義

名前	説明
LockLevel	ロックのレベル。 指定できる値は、NotSpecified、CanNotDelete、ReadOnly です。 CanNotDelete は、承認されたユーザーがリソースの読み取りと変更を行うことができるが、削除できないことを意味します。 ReadOnly は、承認されたユーザーはリソースからのみ読み取ることができるが、変更または削除できないことを意味します。
ManagementLockObject	ロック情報。
ManagementLockOwner	所有者プロパティをロックします。

LockLevel

ロックのレベル。 指定できる値は、NotSpecified、CanNotDelete、ReadOnly です。 CanNotDelete は、承認されたユーザーがリソースの読み取りと変更を行うことができるが、削除できないことを意味します。 ReadOnly は、承認されたユーザーはリソースからのみ読み取ることができるが、変更または削除できないことを意味します。

名前	型	説明
CanNotDelete	string
NotSpecified	string
ReadOnly	string

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。