ResourceGroups interface
ResourceGroups を表すインターフェイス。
メソッド
メソッドの詳細
beginDelete(string, ResourceGroupsDeleteOptionalParams)
リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、そのテンプレート デプロイと現在格納されている操作がすべて削除されます。
function beginDelete(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
削除するリソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)
リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、そのテンプレート デプロイと現在格納されている操作がすべて削除されます。
function beginDeleteAndWait(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
削除するリソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
Promise<void>
beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)
指定したリソース グループをテンプレートとしてキャプチャします。
function beginExportTemplate(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- parameters
- ExportTemplateRequest
テンプレートをエクスポートするためのパラメーター。
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>
beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)
指定したリソース グループをテンプレートとしてキャプチャします。
function beginExportTemplateAndWait(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<ResourceGroupExportResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- parameters
- ExportTemplateRequest
テンプレートをエクスポートするためのパラメーター。
オプション パラメーター。
戻り値
Promise<ResourceGroupExportResult>
checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)
リソース グループが存在するかどうかを確認します。
function checkExistence(resourceGroupName: string, options?: ResourceGroupsCheckExistenceOptionalParams): Promise<ResourceGroupsCheckExistenceResponse>パラメーター
- resourceGroupName
-
string
確認するリソース グループの名前。 名前では大文字と小文字が区別されません。
オプション パラメーター。
戻り値
Promise<ResourceGroupsCheckExistenceResponse>
createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)
リソース グループを作成または更新します。
function createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, options?: ResourceGroupsCreateOrUpdateOptionalParams): Promise<ResourceGroup>パラメーター
- resourceGroupName
-
string
作成または更新するリソース グループの名前。 英数字、アンダースコア、かっこ、ハイフン、ピリオド (末尾を除く)、および使用できる文字に一致する Unicode 文字を含めることができます。
- parameters
- ResourceGroup
リソース グループの作成または更新に指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<ResourceGroup>
get(string, ResourceGroupsGetOptionalParams)
リソース グループを取得します。
function get(resourceGroupName: string, options?: ResourceGroupsGetOptionalParams): Promise<ResourceGroup>パラメーター
- resourceGroupName
-
string
取得するリソース グループの名前。 名前では大文字と小文字が区別されません。
- options
- ResourceGroupsGetOptionalParams
オプション パラメーター。
戻り値
Promise<ResourceGroup>
list(ResourceGroupsListOptionalParams)
サブスクリプションのすべてのリソース グループを取得します。
function list(options?: ResourceGroupsListOptionalParams): PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>パラメーター
- options
- ResourceGroupsListOptionalParams
オプション パラメーター。
戻り値
update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)
リソース グループは、単純な PATCH 操作を使用してグループ アドレスに更新できます。 要求の形式は、リソース グループを作成する場合と同じです。 フィールドが指定されていない場合、現在の値は保持されます。
function update(resourceGroupName: string, parameters: ResourceGroupPatchable, options?: ResourceGroupsUpdateOptionalParams): Promise<ResourceGroup>パラメーター
- resourceGroupName
-
string
更新するリソース グループの名前。 名前では大文字と小文字が区別されません。
- parameters
- ResourceGroupPatchable
リソース グループを更新するために指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<ResourceGroup>