Management Locks - Get By Scope

參考

服務:: Resource Management

API 版本:: 2016-09-01

依範圍取得管理鎖定。

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

URI 參數

名稱	位於	必要	類型	Description
lockName	path	True	string	鎖定的名稱。
scope	path	True	string	鎖定的範圍。
api-version	query	True	string	要用於作業的 API 版本。

回應

名稱	類型	Description
200 OK	ManagementLockObject	確定

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get management lock at scope

範例要求

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

import com.azure.core.util.Context;

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

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_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.get_by_scope(
        scope="subscriptions/subscriptionId",
        lock_name="testlock",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtScope.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 Get a management lock by scope.
 *
 * @summary Get a management lock by scope.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/examples/ManagementLocks_GetAtScope.json
 */
async function getManagementLockAtScope() {
  const subscriptionId =
    process.env["LOCKS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/subscriptionId";
  const lockName = "testlock";
  const credential = new DefaultAzureCredential();
  const client = new ManagementLockClient(credential, subscriptionId);
  const result = await client.managementLocks.getByScope(scope, 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

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_GetAtScope.json
// this example is just showing the usage of "ManagementLocks_GetByScope" 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
string lockName = "testlock";
NullableResponse<ManagementLockResource> response = await collection.GetIfExistsAsync(lockName);
ManagementLockResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

範例回覆

狀態碼:: 200

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

定義

名稱	Description
LockLevel	鎖定的層級。可能的值為：NotSpecified、CanNotDelete、ReadOnly。 CanNotDelete 表示授權的用戶能夠讀取和修改資源，但無法刪除。 ReadOnly 表示授權的使用者只能從資源讀取，但無法修改或刪除它。
ManagementLockObject	鎖定資訊。
ManagementLockOwner	鎖定擁有者屬性。

LockLevel

鎖定的層級。可能的值為：NotSpecified、CanNotDelete、ReadOnly。 CanNotDelete 表示授權的用戶能夠讀取和修改資源，但無法刪除。 ReadOnly 表示授權的使用者只能從資源讀取，但無法修改或刪除它。

名稱	類型	Description
CanNotDelete	string
NotSpecified	string
ReadOnly	string

ManagementLockObject

鎖定資訊。

名稱	類型	Description
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

鎖定擁有者屬性。

名稱	類型	Description
applicationId	string	鎖定擁有者的應用程式識別碼。

共用方式為

Management Locks - Get By Scope

URI 參數

回應

安全性

azure_auth

範圍

範例

Get management lock at scope

範例要求

範例回覆

定義

LockLevel

ManagementLockObject

ManagementLockOwner

其他資源