ResourceGroups interface

Interface representing a ResourceGroups.

Methods

beginDelete(string, ResourceGroupsDeleteOptionalParams)

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.

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

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.

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captures the specified resource group as a template.

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captures the specified resource group as a template.

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Checks whether a resource group exists.

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Creates or updates a resource group.

get(string, ResourceGroupsGetOptionalParams)

Gets a resource group.

list(ResourceGroupsListOptionalParams)

Gets all the resource groups for a subscription.

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

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.

Method Details

beginDelete(string, ResourceGroupsDeleteOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group to delete. The name is case insensitive.

options
ResourceGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group to delete. The name is case insensitive.

options
ResourceGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captures the specified resource group as a template.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

parameters
ExportTemplateRequest

Parameters for exporting the template.

options
ResourceGroupsExportTemplateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captures the specified resource group as a template.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

parameters
ExportTemplateRequest

Parameters for exporting the template.

options
ResourceGroupsExportTemplateOptionalParams

The options parameters.

Returns

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Checks whether a resource group exists.

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

Parameters

resourceGroupName

string

The name of the resource group to check. The name is case insensitive.

options
ResourceGroupsCheckExistenceOptionalParams

The options parameters.

Returns

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Creates or updates a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.

parameters
ResourceGroup

Parameters supplied to the create or update a resource group.

options
ResourceGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ResourceGroup>

get(string, ResourceGroupsGetOptionalParams)

Gets a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group to get. The name is case insensitive.

options
ResourceGroupsGetOptionalParams

The options parameters.

Returns

Promise<ResourceGroup>

list(ResourceGroupsListOptionalParams)

Gets all the resource groups for a subscription.

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

Parameters

options
ResourceGroupsListOptionalParams

The options parameters.

Returns

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group to update. The name is case insensitive.

parameters
ResourceGroupPatchable

Parameters supplied to update a resource group.

options
ResourceGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<ResourceGroup>