Resources interface
リソースを表すインターフェイス。
メソッド
メソッドの詳細
beginCreateOrUpdate(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)
リソースを作成します。
function beginCreateOrUpdate(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>パラメーター
- resourceGroupName
-
string
リソースのリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
作成するリソースのリソースの種類。
- resourceName
-
string
作成するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソースを作成または更新するためのパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>
beginCreateOrUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesCreateOrUpdateOptionalParams)
リソースを作成します。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams): Promise<GenericResource>パラメーター
- resourceGroupName
-
string
リソースのリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
作成するリソースのリソースの種類。
- resourceName
-
string
作成するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソースを作成または更新するためのパラメーター。
オプション パラメーター。
戻り値
Promise<GenericResource>
beginCreateOrUpdateById(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)
ID でリソースを作成します。
function beginCreateOrUpdateById(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams): Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソース パラメーターを作成または更新します。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>
beginCreateOrUpdateByIdAndWait(string, string, GenericResource, ResourcesCreateOrUpdateByIdOptionalParams)
ID でリソースを作成します。
function beginCreateOrUpdateByIdAndWait(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams): Promise<GenericResource>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソース パラメーターを作成または更新します。
オプション パラメーター。
戻り値
Promise<GenericResource>
beginDelete(string, string, string, string, string, string, ResourcesDeleteOptionalParams)
リソースを削除します。
function beginDelete(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
削除するリソースを含むリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
リソースの種類。
- resourceName
-
string
削除するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- options
- ResourcesDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, string, ResourcesDeleteOptionalParams)
リソースを削除します。
function beginDeleteAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
削除するリソースを含むリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
リソースの種類。
- resourceName
-
string
削除するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- options
- ResourcesDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
beginDeleteById(string, string, ResourcesDeleteByIdOptionalParams)
ID でリソースを削除します。
function beginDeleteById(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteByIdAndWait(string, string, ResourcesDeleteByIdOptionalParams)
ID でリソースを削除します。
function beginDeleteByIdAndWait(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams): Promise<void>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
オプション パラメーター。
戻り値
Promise<void>
beginMoveResources(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)
移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションにある可能性があります。 リソースを移動すると、操作の間、ソース グループとターゲット グループの両方がロックされます。 移動が完了するまで、グループに対する書き込み操作と削除操作はブロックされます。
function beginMoveResources(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- sourceResourceGroupName
-
string
移動するリソースを含むソース サブスクリプションのリソース グループの名前。
- parameters
- ResourcesMoveInfo
リソースを移動するためのパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesMoveResourcesOptionalParams)
移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションにある可能性があります。 リソースを移動すると、操作の間、ソース グループとターゲット グループの両方がロックされます。 移動が完了するまで、グループに対する書き込み操作と削除操作はブロックされます。
function beginMoveResourcesAndWait(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams): Promise<void>パラメーター
- sourceResourceGroupName
-
string
移動するリソースを含むソース サブスクリプションのリソース グループの名前。
- parameters
- ResourcesMoveInfo
リソースを移動するためのパラメーター。
オプション パラメーター。
戻り値
Promise<void>
beginUpdate(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)
リソースを更新します。
function beginUpdate(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>パラメーター
- resourceGroupName
-
string
リソースのリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
更新するリソースのリソースの種類。
- resourceName
-
string
更新するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソースを更新するためのパラメーター。
- options
- ResourcesUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>
beginUpdateAndWait(string, string, string, string, string, string, GenericResource, ResourcesUpdateOptionalParams)
リソースを更新します。
function beginUpdateAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams): Promise<GenericResource>パラメーター
- resourceGroupName
-
string
リソースのリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
更新するリソースのリソースの種類。
- resourceName
-
string
更新するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソースを更新するためのパラメーター。
- options
- ResourcesUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<GenericResource>
beginUpdateById(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)
ID でリソースを更新します。
function beginUpdateById(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams): Promise<SimplePollerLike<OperationState<GenericResource>, GenericResource>>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソース パラメーターを更新します。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenericResource>, GenericResource>>
beginUpdateByIdAndWait(string, string, GenericResource, ResourcesUpdateByIdOptionalParams)
ID でリソースを更新します。
function beginUpdateByIdAndWait(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams): Promise<GenericResource>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
- parameters
- GenericResource
リソース パラメーターを更新します。
オプション パラメーター。
戻り値
Promise<GenericResource>
beginValidateMoveResources(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)
この操作では、指定したリソースをターゲットに移動できるかどうかを確認します。 移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションにある可能性があります。 検証が成功すると、HTTP 応答コード 204 (コンテンツなし) が返されます。 検証に失敗すると、HTTP 応答コード 409 (競合) とエラー メッセージが返されます。 Location ヘッダー値の URL を取得して、実行時間の長い操作の結果を確認します。
function beginValidateMoveResources(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- sourceResourceGroupName
-
string
移動の検証対象となるリソースを含むソース サブスクリプションのリソース グループの名前。
- parameters
- ResourcesMoveInfo
リソースを移動するためのパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginValidateMoveResourcesAndWait(string, ResourcesMoveInfo, ResourcesValidateMoveResourcesOptionalParams)
この操作では、指定したリソースをターゲットに移動できるかどうかを確認します。 移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションにある可能性があります。 検証が成功すると、HTTP 応答コード 204 (コンテンツなし) が返されます。 検証に失敗すると、HTTP 応答コード 409 (競合) とエラー メッセージが返されます。 Location ヘッダー値の URL を取得して、実行時間の長い操作の結果を確認します。
function beginValidateMoveResourcesAndWait(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams): Promise<void>パラメーター
- sourceResourceGroupName
-
string
移動の検証対象となるリソースを含むソース サブスクリプションのリソース グループの名前。
- parameters
- ResourcesMoveInfo
リソースを移動するためのパラメーター。
オプション パラメーター。
戻り値
Promise<void>
checkExistence(string, string, string, string, string, string, ResourcesCheckExistenceOptionalParams)
リソースが存在するかどうかを確認します。
function checkExistence(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesCheckExistenceOptionalParams): Promise<ResourcesCheckExistenceResponse>パラメーター
- resourceGroupName
-
string
チェックするリソースを含むリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
確認するリソースのリソース プロバイダー。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
リソースの種類。
- resourceName
-
string
リソースが存在するかどうかを確認するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
オプション パラメーター。
戻り値
Promise<ResourcesCheckExistenceResponse>
checkExistenceById(string, string, ResourcesCheckExistenceByIdOptionalParams)
リソースが存在するかどうかを ID で確認します。 この API は現在、限られたリソース プロバイダーのセットに対してのみ機能します。 リソース プロバイダーがこの API を実装していない場合、ARM は 405 で応答します。 代わりに、GET API を使用してリソースの存在を確認します。
function checkExistenceById(resourceId: string, apiVersion: string, options?: ResourcesCheckExistenceByIdOptionalParams): Promise<ResourcesCheckExistenceByIdResponse>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
オプション パラメーター。
戻り値
Promise<ResourcesCheckExistenceByIdResponse>
get(string, string, string, string, string, string, ResourcesGetOptionalParams)
リソースを取得します。
function get(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesGetOptionalParams): Promise<GenericResource>パラメーター
- resourceGroupName
-
string
取得するリソースを含むリソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceProviderNamespace
-
string
リソース プロバイダーの名前空間。
- parentResourcePath
-
string
親リソース ID。
- resourceType
-
string
リソースのリソースの種類。
- resourceName
-
string
取得するリソースの名前。
- apiVersion
-
string
操作に使用する API バージョン。
- options
- ResourcesGetOptionalParams
オプション パラメーター。
戻り値
Promise<GenericResource>
getById(string, string, ResourcesGetByIdOptionalParams)
ID でリソースを取得します。
function getById(resourceId: string, apiVersion: string, options?: ResourcesGetByIdOptionalParams): Promise<GenericResource>パラメーター
- resourceId
-
string
リソース名とリソースの種類を含む、リソースの完全修飾 ID。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します
- apiVersion
-
string
操作に使用する API バージョン。
- options
- ResourcesGetByIdOptionalParams
オプション パラメーター。
戻り値
Promise<GenericResource>
list(ResourcesListOptionalParams)
サブスクリプション内のすべてのリソースを取得します。
function list(options?: ResourcesListOptionalParams): PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>パラメーター
- options
- ResourcesListOptionalParams
オプション パラメーター。
戻り値
listByResourceGroup(string, ResourcesListByResourceGroupOptionalParams)
リソース グループのすべてのリソースを取得します。
function listByResourceGroup(resourceGroupName: string, options?: ResourcesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GenericResourceExpanded, GenericResourceExpanded[], PageSettings>パラメーター
- resourceGroupName
-
string
取得するリソースを含むリソース グループ。
オプション パラメーター。