你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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>