ResourceGroupsOperations interface

Package:

@azure/arm-resources

Interface representing a ResourceGroups operations.

Properties

beginDelete
beginDeleteAndWait
beginExportTemplate
beginExportTemplateAndWait
checkExistence	Checks whether a resource group exists.
createOrUpdate	Creates or updates a resource group.
delete	When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
exportTemplate	Captures the specified resource group as a template.
get	Gets a resource group.
list	Gets all the resource groups for a subscription.
update	Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Property Details

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => Promise<void>

beginExportTemplate

Warning

This API is now deprecated.

use exportTemplate instead

beginExportTemplate: (resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => Promise<SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>

Property Value

(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => Promise<SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>

beginExportTemplateAndWait

Warning

This API is now deprecated.

use exportTemplate instead

beginExportTemplateAndWait: (resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => Promise<ResourceGroupExportResult>

Property Value

(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => Promise<ResourceGroupExportResult>

checkExistence

Checks whether a resource group exists.

checkExistence: (resourceGroupName: string, options?: ResourceGroupsCheckExistenceOptionalParams) => Promise<ResourceGroupsCheckExistenceResponse>

Property Value

(resourceGroupName: string, options?: ResourceGroupsCheckExistenceOptionalParams) => Promise<ResourceGroupsCheckExistenceResponse>

createOrUpdate

Creates or updates a resource group.

createOrUpdate: (resourceGroupName: string, parameters: ResourceGroup, options?: ResourceGroupsCreateOrUpdateOptionalParams) => Promise<ResourceGroup>

Property Value

(resourceGroupName: string, parameters: ResourceGroup, options?: ResourceGroupsCreateOrUpdateOptionalParams) => Promise<ResourceGroup>

delete

When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

delete: (resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

exportTemplate

Captures the specified resource group as a template.

exportTemplate: (resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => PollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>

Property Value

(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams) => PollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>

get

Gets a resource group.

get: (resourceGroupName: string, options?: ResourceGroupsGetOptionalParams) => Promise<ResourceGroup>

Property Value

(resourceGroupName: string, options?: ResourceGroupsGetOptionalParams) => Promise<ResourceGroup>

list

Gets all the resource groups for a subscription.

list: (options?: ResourceGroupsListOptionalParams) => PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

Property Value

(options?: ResourceGroupsListOptionalParams) => PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

update

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

update: (resourceGroupName: string, parameters: ResourceGroupPatchable, options?: ResourceGroupsUpdateOptionalParams) => Promise<ResourceGroup>

Property Value

(resourceGroupName: string, parameters: ResourceGroupPatchable, options?: ResourceGroupsUpdateOptionalParams) => Promise<ResourceGroup>