Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResourceGroups

Package version

Class representing a ResourceGroups.

Hierarchy

  • ResourceGroups

Index

Constructors

Methods

Constructors

constructor

Methods

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • 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.

    summary

    Deletes a resource group.

    Parameters

    • resourceGroupName: string

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

checkExistence

  • checkExistence(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceGroupsCheckExistenceResponse>
  • checkExistence(resourceGroupName: string, callback: msRest.ServiceCallback<boolean>): void
  • checkExistence(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<boolean>): void

  • Checks whether a resource group exists.

    Parameters

    • resourceGroupName: string

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsCheckExistenceResponse>

    Promise<Models.ResourceGroupsCheckExistenceResponse>

  • Parameters

    • resourceGroupName: string

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

    • callback: msRest.ServiceCallback<boolean>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

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

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<boolean>

      The callback

    Returns void

createOrUpdate

  • createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, options?: msRest.RequestOptionsBase): Promise<Models.ResourceGroupsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, callback: msRest.ServiceCallback<ResourceGroup>): void
  • createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceGroup>): void

  • Creates or updates a resource group.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsCreateOrUpdateResponse>

    Promise<Models.ResourceGroupsCreateOrUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • 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.

    summary

    Deletes a resource group.

    Parameters

    • resourceGroupName: string

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

exportTemplate

  • Captures the specified resource group as a template.

    Parameters

    • resourceGroupName: string

      The name of the resource group to export as a template.

    • parameters: ExportTemplateRequest

      Parameters for exporting the template.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsExportTemplateResponse>

    Promise<Models.ResourceGroupsExportTemplateResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group to export as a template.

    • parameters: ExportTemplateRequest

      Parameters for exporting the template.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceGroupExportResult>

      The callback

    Returns void

get

  • get(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceGroupsGetResponse>
  • get(resourceGroupName: string, callback: msRest.ServiceCallback<ResourceGroup>): void
  • get(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceGroup>): void

  • Gets a resource group.

    Parameters

    • resourceGroupName: string

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsGetResponse>

    Promise<Models.ResourceGroupsGetResponse>

  • Parameters

    • resourceGroupName: string

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

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

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

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

list

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceGroupsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<ResourceGroupListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceGroupListResult>): void

  • Gets all the resource groups for a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsListNextResponse>

    Promise<Models.ResourceGroupsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ResourceGroupListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceGroupListResult>

      The callback

    Returns void

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.

    summary

    Updates a resource group.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceGroupsUpdateResponse>

    Promise<Models.ResourceGroupsUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceGroup>

      The callback

    Returns void

Generated using TypeDoc