ResourceGroups interface

Pacote:

@azure/arm-resources

Interface que representa um ResourceGroups.

Métodos

beginDelete(string, ResourceGroupsDeleteOptionalParams)	Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as suas implantações de modelo e operações armazenadas no momento.
beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)	Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as suas implantações de modelo e operações armazenadas no momento.
beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Captura o grupo de recursos especificado como um modelo.
beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Captura o grupo de recursos especificado como um modelo.
checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)	Verifica se existe um grupo de recursos.
createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)	Cria ou atualiza um grupo de recursos.
get(string, ResourceGroupsGetOptionalParams)	Obtém um grupo de recursos.
list(ResourceGroupsListOptionalParams)	Obtém todos os grupos de recursos de uma assinatura.
update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)	Os grupos de recursos podem ser atualizados por meio de uma operação PATCH simples para um endereço de grupo. O formato da solicitação é o mesmo para a criação de um grupo de recursos. Se um campo não for especificado, o valor atual será retido.

Detalhes do método

beginDelete(string, ResourceGroupsDeleteOptionalParams)

Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as suas implantações de modelo e operações armazenadas no momento.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser excluído. O nome não diferencia maiúsculas de minúsculas.

options

ResourceGroupsDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

Quando você exclui um grupo de recursos, todos os seus recursos também são excluídos. Excluir um grupo de recursos exclui todas as suas implantações de modelo e operações armazenadas no momento.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser excluído. O nome não diferencia maiúsculas de minúsculas.

options

ResourceGroupsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captura o grupo de recursos especificado como um modelo.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

parameters

ExportTemplateRequest

Parâmetros para exportar o modelo.

options

ResourceGroupsExportTemplateOptionalParams

Os parâmetros de opções.

Retornos

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

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Captura o grupo de recursos especificado como um modelo.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

parameters

ExportTemplateRequest

Parâmetros para exportar o modelo.

options

ResourceGroupsExportTemplateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceGroupExportResult>

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Verifica se existe um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser verificado. O nome não diferencia maiúsculas de minúsculas.

options

ResourceGroupsCheckExistenceOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceGroupsCheckExistenceResponse>

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Cria ou atualiza um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser criado ou atualizado. Pode incluir caracteres alfanuméricos, sublinhados, parênteses, hifen, ponto (exceto no final) e caracteres Unicode que correspondem aos caracteres permitidos.

parameters

ResourceGroup

Parâmetros fornecidos para criar ou atualizar um grupo de recursos.

options

ResourceGroupsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceGroup>

get(string, ResourceGroupsGetOptionalParams)

Obtém um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser obtido. O nome não diferencia maiúsculas de minúsculas.

options

ResourceGroupsGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceGroup>

list(ResourceGroupsListOptionalParams)

Obtém todos os grupos de recursos de uma assinatura.

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

Parâmetros

options

ResourceGroupsListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

Os grupos de recursos podem ser atualizados por meio de uma operação PATCH simples para um endereço de grupo. O formato da solicitação é o mesmo para a criação de um grupo de recursos. Se um campo não for especificado, o valor atual será retido.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos a ser atualizado. O nome não diferencia maiúsculas de minúsculas.

parameters

ResourceGroupPatchable

Parâmetros fornecidos para atualizar um grupo de recursos.

options

ResourceGroupsUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceGroup>