ResourceGroups interface

Paket:

@azure/arm-resources

Gränssnitt som representerar en ResourceGroups.

Metoder

beginDelete(string, ResourceGroupsDeleteOptionalParams)	När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.
beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)	När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.
beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Samlar in den angivna resursgruppen som en mall.
beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Samlar in den angivna resursgruppen som en mall.
checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)	Kontrollerar om det finns en resursgrupp.
createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)	Skapar eller uppdaterar en resursgrupp.
get(string, ResourceGroupsGetOptionalParams)	Hämtar en resursgrupp.
list(ResourceGroupsListOptionalParams)	Hämtar alla resursgrupper för en prenumeration.
update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)	Resursgrupper kan uppdateras via en enkel PATCH-åtgärd till en gruppadress. Formatet för begäran är detsamma som för att skapa en resursgrupp. Om ett fält är ospecificerat behålls det aktuella värdet.

Metodinformation

beginDelete(string, ResourceGroupsDeleteOptionalParams)

När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som ska tas bort. Namnet är skiftlägesokänsligt.

options

ResourceGroupsDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som ska tas bort. Namnet är skiftlägesokänsligt.

options

ResourceGroupsDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Samlar in den angivna resursgruppen som en mall.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

parameters

ExportTemplateRequest

Parametrar för att exportera mallen.

options

ResourceGroupsExportTemplateOptionalParams

Alternativparametrarna.

Returer

Promise<SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Samlar in den angivna resursgruppen som en mall.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

parameters

ExportTemplateRequest

Parametrar för att exportera mallen.

options

ResourceGroupsExportTemplateOptionalParams

Alternativparametrarna.

Returer

Promise<ResourceGroupExportResult>

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Kontrollerar om det finns en resursgrupp.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som ska kontrolleras. Namnet är skiftlägesokänsligt.

options

ResourceGroupsCheckExistenceOptionalParams

Alternativparametrarna.

Returer

Promise<ResourceGroupsCheckExistenceResponse>

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Skapar eller uppdaterar en resursgrupp.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som ska skapas eller uppdateras. Kan innehålla alfanumeriska tecken, understreck, parenteser, bindestreck, punkt (utom i slutet) och Unicode-tecken som matchar de tillåtna tecknen.

parameters

ResourceGroup

Parametrar som anges för att skapa eller uppdatera en resursgrupp.

options

ResourceGroupsCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ResourceGroup>

get(string, ResourceGroupsGetOptionalParams)

Hämtar en resursgrupp.

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

Parametrar

resourceGroupName

string

Namnet på den resursgrupp som ska hämtas. Namnet är skiftlägesokänsligt.

options

ResourceGroupsGetOptionalParams

Alternativparametrarna.

Returer

Promise<ResourceGroup>

list(ResourceGroupsListOptionalParams)

Hämtar alla resursgrupper för en prenumeration.

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

Parametrar

options

ResourceGroupsListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

Resursgrupper kan uppdateras via en enkel PATCH-åtgärd till en gruppadress. Formatet för begäran är detsamma som för att skapa en resursgrupp. Om ett fält är ospecificerat behålls det aktuella värdet.

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

Parametrar

resourceGroupName

string

Namnet på den resursgrupp som ska uppdateras. Namnet är skiftlägesokänsligt.

parameters

ResourceGroupPatchable

Parametrar som anges för att uppdatera en resursgrupp.

options

ResourceGroupsUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ResourceGroup>