ResourceGroups interface

Paquet:

@azure/arm-resources

Interface représentant un ResourceGroups.

Méthodes

beginDelete(string, ResourceGroupsDeleteOptionalParams)	Lorsque vous supprimez un groupe de ressources, toutes ses ressources sont également supprimées. La suppression d’un groupe de ressources supprime tous ses déploiements de modèles et les opérations actuellement stockées.
beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)	Lorsque vous supprimez un groupe de ressources, toutes ses ressources sont également supprimées. La suppression d’un groupe de ressources supprime tous ses déploiements de modèles et les opérations actuellement stockées.
beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Capture le groupe de ressources spécifié en tant que modèle.
beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Capture le groupe de ressources spécifié en tant que modèle.
checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)	Vérifie si un groupe de ressources existe.
createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)	Crée ou met à jour un groupe de ressources.
get(string, ResourceGroupsGetOptionalParams)	Obtient un groupe de ressources.
list(ResourceGroupsListOptionalParams)	Obtient tous les groupes de ressources d’un abonnement.
update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)	Les groupes de ressources peuvent être mis à jour via une opération PATCH simple vers une adresse de groupe. Le format de la requête est identique à celui de la création d’un groupe de ressources. Si un champ n’est pas spécifié, la valeur actuelle est conservée.

Détails de la méthode

beginDelete(string, ResourceGroupsDeleteOptionalParams)

Lorsque vous supprimez un groupe de ressources, toutes ses ressources sont également supprimées. La suppression d’un groupe de ressources supprime tous ses déploiements de modèles et les opérations actuellement stockées.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à supprimer. Le nom ne respecte pas la casse.

options

ResourceGroupsDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

Lorsque vous supprimez un groupe de ressources, toutes ses ressources sont également supprimées. La suppression d’un groupe de ressources supprime tous ses déploiements de modèles et les opérations actuellement stockées.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à supprimer. Le nom ne respecte pas la casse.

options

ResourceGroupsDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Capture le groupe de ressources spécifié en tant que modèle.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

parameters

ExportTemplateRequest

Paramètres pour l’exportation du modèle.

options

ResourceGroupsExportTemplateOptionalParams

Paramètres d’options.

Retours

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

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Capture le groupe de ressources spécifié en tant que modèle.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

parameters

ExportTemplateRequest

Paramètres pour l’exportation du modèle.

options

ResourceGroupsExportTemplateOptionalParams

Paramètres d’options.

Retours

Promise<ResourceGroupExportResult>

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Vérifie si un groupe de ressources existe.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à vérifier. Le nom ne respecte pas la casse.

options

ResourceGroupsCheckExistenceOptionalParams

Paramètres d’options.

Retours

Promise<ResourceGroupsCheckExistenceResponse>

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Crée ou met à jour un groupe de ressources.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à créer ou à mettre à jour. Peut inclure des caractères alphanumériques, traits de soulignement, parenthèses, traits d’union, point (sauf à la fin) et caractères Unicode qui correspondent aux caractères autorisés.

parameters

ResourceGroup

Paramètres fournis à la création ou à la mise à jour d’un groupe de ressources.

options

ResourceGroupsCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ResourceGroup>

get(string, ResourceGroupsGetOptionalParams)

Obtient un groupe de ressources.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à obtenir. Le nom ne respecte pas la casse.

options

ResourceGroupsGetOptionalParams

Paramètres d’options.

Retours

Promise<ResourceGroup>

list(ResourceGroupsListOptionalParams)

Obtient tous les groupes de ressources d’un abonnement.

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

Paramètres

options

ResourceGroupsListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

Les groupes de ressources peuvent être mis à jour via une opération PATCH simple vers une adresse de groupe. Le format de la requête est identique à celui de la création d’un groupe de ressources. Si un champ n’est pas spécifié, la valeur actuelle est conservée.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources à mettre à jour. Le nom ne respecte pas la casse.

parameters

ResourceGroupPatchable

Paramètres fournis pour mettre à jour un groupe de ressources.

options

ResourceGroupsUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ResourceGroup>