ManagementLocks interface
ManagementLocks を表すインターフェイス。
メソッド
メソッドの詳細
createOrUpdateAtResourceGroupLevel(string, string, ManagementLockObject, ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams)
親スコープでロックを適用すると、すべての子リソースが同じロックを継承します。 管理ロックを作成するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function createOrUpdateAtResourceGroupLevel(resourceGroupName: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- resourceGroupName
-
string
ロックするリソース グループの名前。
- lockName
-
string
ロック名。 ロック名には最大 260 文字を指定できます。 <、> %、&、:、?、/、またはコントロール文字を含めることはできません。
- parameters
- ManagementLockObject
管理ロック パラメーター。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
createOrUpdateAtResourceLevel(string, string, string, string, string, string, ManagementLockObject, ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams)
親スコープでロックを適用すると、すべての子リソースが同じロックを継承します。 管理ロックを作成するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function createOrUpdateAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- resourceGroupName
-
string
ロックするリソースを含むリソース グループの名前。
- resourceProviderNamespace
-
string
ロックするリソースのリソース プロバイダー名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
ロックするリソースのリソースの種類。
- resourceName
-
string
ロックするリソースの名前。
- lockName
-
string
ロックの名前。 ロック名には最大 260 文字を指定できます。 <、> %、&、:、?、/、またはコントロール文字を含めることはできません。
- parameters
- ManagementLockObject
管理ロックを作成または更新するためのパラメーター。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
createOrUpdateAtSubscriptionLevel(string, ManagementLockObject, ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams)
親スコープでロックを適用すると、すべての子リソースが同じロックを継承します。 管理ロックを作成するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function createOrUpdateAtSubscriptionLevel(lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- lockName
-
string
ロックの名前。 ロック名には最大 260 文字を指定できます。 <、> %、&、:、?、/、またはコントロール文字を含めることはできません。
- parameters
- ManagementLockObject
管理ロック パラメーター。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
createOrUpdateByScope(string, string, ManagementLockObject, ManagementLocksCreateOrUpdateByScopeOptionalParams)
スコープ別に管理ロックを作成または更新します。
function createOrUpdateByScope(scope: string, lockName: string, parameters: ManagementLockObject, options?: ManagementLocksCreateOrUpdateByScopeOptionalParams): Promise<ManagementLockObject>パラメーター
- scope
-
string
ロックのスコープ。 割り当てのスコープを指定するときは、サブスクリプションに '/subscriptions/{subscriptionId}' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' を使用し、リソースには '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' を使用します。
- lockName
-
string
ロックの名前。
- parameters
- ManagementLockObject
管理ロック パラメーターを作成または更新します。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
deleteAtResourceGroupLevel(string, string, ManagementLocksDeleteAtResourceGroupLevelOptionalParams)
管理ロックを削除するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function deleteAtResourceGroupLevel(resourceGroupName: string, lockName: string, options?: ManagementLocksDeleteAtResourceGroupLevelOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
ロックを含むリソース グループの名前。
- lockName
-
string
削除するロックの名前。
オプション パラメーター。
戻り値
Promise<void>
deleteAtResourceLevel(string, string, string, string, string, string, ManagementLocksDeleteAtResourceLevelOptionalParams)
管理ロックを削除するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function deleteAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, options?: ManagementLocksDeleteAtResourceLevelOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
削除するロックを持つリソースを含むリソース グループの名前。
- resourceProviderNamespace
-
string
削除するロックを持つリソースのリソース プロバイダー名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
削除するロックを持つリソースのリソースの種類。
- resourceName
-
string
削除するロックを持つリソースの名前。
- lockName
-
string
削除するロックの名前。
オプション パラメーター。
戻り値
Promise<void>
deleteAtSubscriptionLevel(string, ManagementLocksDeleteAtSubscriptionLevelOptionalParams)
管理ロックを削除するには、Microsoft.Authorization/* または Microsoft.Authorization/locks/* アクションにアクセスできる必要があります。 組み込みロールのうち、所有者とユーザー アクセス管理者にのみこれらのアクションが付与されます。
function deleteAtSubscriptionLevel(lockName: string, options?: ManagementLocksDeleteAtSubscriptionLevelOptionalParams): Promise<void>パラメーター
- lockName
-
string
削除するロックの名前。
オプション パラメーター。
戻り値
Promise<void>
deleteByScope(string, string, ManagementLocksDeleteByScopeOptionalParams)
スコープ別に管理ロックを削除します。
function deleteByScope(scope: string, lockName: string, options?: ManagementLocksDeleteByScopeOptionalParams): Promise<void>パラメーター
- scope
-
string
ロックのスコープ。
- lockName
-
string
ロックの名前。
オプション パラメーター。
戻り値
Promise<void>
getAtResourceGroupLevel(string, string, ManagementLocksGetAtResourceGroupLevelOptionalParams)
リソース グループ レベルで管理ロックを取得します。
function getAtResourceGroupLevel(resourceGroupName: string, lockName: string, options?: ManagementLocksGetAtResourceGroupLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- resourceGroupName
-
string
ロックされたリソース グループの名前。
- lockName
-
string
取得するロックの名前。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
getAtResourceLevel(string, string, string, string, string, string, ManagementLocksGetAtResourceLevelOptionalParams)
リソースの管理ロックまたはリソースより下の任意のレベルを取得します。
function getAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, lockName: string, options?: ManagementLocksGetAtResourceLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- resourceGroupName
-
string
リソース グループの名前。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
SQL Database など、一部のサービスで必要な追加のパス パラメーター。
- resourceType
-
string
リソースの種類。
- resourceName
-
string
リソースの名前。
- lockName
-
string
ロックの名前。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
getAtSubscriptionLevel(string, ManagementLocksGetAtSubscriptionLevelOptionalParams)
サブスクリプション レベルで管理ロックを取得します。
function getAtSubscriptionLevel(lockName: string, options?: ManagementLocksGetAtSubscriptionLevelOptionalParams): Promise<ManagementLockObject>パラメーター
- lockName
-
string
取得するロックの名前。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
getByScope(string, string, ManagementLocksGetByScopeOptionalParams)
スコープ別に管理ロックを取得します。
function getByScope(scope: string, lockName: string, options?: ManagementLocksGetByScopeOptionalParams): Promise<ManagementLockObject>パラメーター
- scope
-
string
ロックのスコープ。
- lockName
-
string
ロックの名前。
オプション パラメーター。
戻り値
Promise<ManagementLockObject>
listAtResourceGroupLevel(string, ManagementLocksListAtResourceGroupLevelOptionalParams)
リソース グループのすべての管理ロックを取得します。
function listAtResourceGroupLevel(resourceGroupName: string, options?: ManagementLocksListAtResourceGroupLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[], PageSettings>パラメーター
- resourceGroupName
-
string
取得するロックを含むリソース グループの名前。
オプション パラメーター。
戻り値
listAtResourceLevel(string, string, string, string, string, ManagementLocksListAtResourceLevelOptionalParams)
リソースまたはリソースより下の任意のレベルのすべての管理ロックを取得します。
function listAtResourceLevel(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, options?: ManagementLocksListAtResourceLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[], PageSettings>パラメーター
- resourceGroupName
-
string
ロックされたリソースを含むリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
ロックされているリソースのリソースの種類。
- resourceName
-
string
ロックされたリソースの名前。
オプション パラメーター。
戻り値
listAtSubscriptionLevel(ManagementLocksListAtSubscriptionLevelOptionalParams)
サブスクリプションのすべての管理ロックを取得します。
function listAtSubscriptionLevel(options?: ManagementLocksListAtSubscriptionLevelOptionalParams): PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[], PageSettings>パラメーター
オプション パラメーター。
戻り値
listByScope(string, ManagementLocksListByScopeOptionalParams)
スコープのすべての管理ロックを取得します。
function listByScope(scope: string, options?: ManagementLocksListByScopeOptionalParams): PagedAsyncIterableIterator<ManagementLockObject, ManagementLockObject[], PageSettings>パラメーター
- scope
-
string
ロックのスコープ。 割り当てのスコープを指定するときは、サブスクリプションに '/subscriptions/{subscriptionId}' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' を使用し、リソースには '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}' を使用します。
オプション パラメーター。