ResourceGroups interface
代表 ResourceGroups 的介面。
方法
| begin |
當您刪除資源群組時，也會刪除其所有資源。 刪除資源群組會刪除其所有範本部署和目前儲存的作業。 |
| begin |
當您刪除資源群組時，也會刪除其所有資源。 刪除資源群組會刪除其所有範本部署和目前儲存的作業。 |
| begin |
將指定的資源群組擷取為範本。 |
| begin |
將指定的資源群組擷取為範本。 |
| check |
檢查資源群組是否存在。 |
| create |
建立或更新資源群組。 |
| get(string, Resource |
取得資源群組。 |
| list(Resource |
取得訂用帳戶的所有資源群組。 |
| update(string, Resource |
您可以透過簡單的 PATCH 作業將資源群組更新到群組位址。 要求的格式與建立資源群組的格式相同。 如果未指定欄位，則會保留目前的值。 |
方法詳細資料
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>