Blueprints - Delete

Service:

Blueprints

Version d'API:

2018-11-01-preview

Supprimer une définition de blueprint.

DELETE https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}?api-version=2018-11-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
blueprintName	path	True	string	Nom de la définition de blueprint.
resourceScope	path	True	string	Portée de la ressource. Les étendues valides sont les suivantes : groupe d’administration (format : « /providers/Microsoft.Management/managementGroups/{managementGroup} »), abonnement (format : « /subscriptions/{subscriptionId} »).
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	Blueprint	OK : définition de blueprint supprimée.
204 No Content		Pas de contenu
Other Status Codes	CloudError	Réponse d’erreur blueprints.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ManagementGroupBlueprint

SubscriptionBlueprint

ManagementGroupBlueprint

Exemple de requête

HTTP

DELETE https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

Go

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Delete.json
func ExampleBlueprintsClient_Delete_managementGroupBlueprint() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBlueprintsClient().Delete(ctx, "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", "simpleBlueprint", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Blueprint = armblueprint.Blueprint{
	// 	Name: to.Ptr("simpleBlueprint"),
	// 	Type: to.Ptr("Microsoft.Blueprint/blueprints"),
	// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
	// 	Properties: &armblueprint.Properties{
	// 		Description: to.Ptr("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
	// 		Parameters: map[string]*armblueprint.ParameterDefinition{
	// 			"costCenter": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeString),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("force cost center tag for all resources under given subscription."),
	// 				},
	// 			},
	// 			"owners": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeArray),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("assign owners to subscription along with blueprint assignment."),
	// 				},
	// 			},
	// 			"storageAccountType": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeString),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("storage account type."),
	// 				},
	// 			},
	// 		},
	// 		ResourceGroups: map[string]*armblueprint.ResourceGroupDefinition{
	// 			"storageRG": &armblueprint.ResourceGroupDefinition{
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					Description: to.Ptr("Contains storageAccounts that collect all shoebox logs."),
	// 					DisplayName: to.Ptr("storage resource group"),
	// 				},
	// 			},
	// 		},
	// 		TargetScope: to.Ptr(armblueprint.BlueprintTargetScopeSubscription),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Delete.json
// this example is just showing the usage of "Blueprints_Delete" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BlueprintResource created on azure
// for more information of creating BlueprintResource, please refer to the document of BlueprintResource
string resourceScope = "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup";
string blueprintName = "simpleBlueprint";
ResourceIdentifier blueprintResourceId = BlueprintResource.CreateResourceIdentifier(resourceScope, blueprintName);
BlueprintResource blueprint = client.GetBlueprintResource(blueprintResourceId);

// invoke the operation
ArmOperation<BlueprintResource> lro = await blueprint.DeleteAsync(WaitUntil.Completed);
BlueprintResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BlueprintData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription",
    "status": null
  },
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

Code d’état:

204

SubscriptionBlueprint

Exemple de requête

HTTP

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

Go

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Delete.json
func ExampleBlueprintsClient_Delete_subscriptionBlueprint() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBlueprintsClient().Delete(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", "simpleBlueprint", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Blueprint = armblueprint.Blueprint{
	// 	Name: to.Ptr("simpleBlueprint"),
	// 	Type: to.Ptr("Microsoft.Blueprint/blueprints"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
	// 	Properties: &armblueprint.Properties{
	// 		Description: to.Ptr("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
	// 		Parameters: map[string]*armblueprint.ParameterDefinition{
	// 			"costCenter": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeString),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("force cost center tag for all resources under given subscription."),
	// 				},
	// 			},
	// 			"owners": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeArray),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("assign owners to subscription along with blueprint assignment."),
	// 				},
	// 			},
	// 			"storageAccountType": &armblueprint.ParameterDefinition{
	// 				Type: to.Ptr(armblueprint.TemplateParameterTypeString),
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					DisplayName: to.Ptr("storage account type."),
	// 				},
	// 			},
	// 		},
	// 		ResourceGroups: map[string]*armblueprint.ResourceGroupDefinition{
	// 			"storageRG": &armblueprint.ResourceGroupDefinition{
	// 				Metadata: &armblueprint.ParameterDefinitionMetadata{
	// 					Description: to.Ptr("Contains storageAccounts that collect all shoebox logs."),
	// 					DisplayName: to.Ptr("storage resource group"),
	// 				},
	// 			},
	// 		},
	// 		TargetScope: to.Ptr(armblueprint.BlueprintTargetScopeSubscription),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Delete.json
// this example is just showing the usage of "Blueprints_Delete" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BlueprintResource created on azure
// for more information of creating BlueprintResource, please refer to the document of BlueprintResource
string resourceScope = "subscriptions/00000000-0000-0000-0000-000000000000";
string blueprintName = "simpleBlueprint";
ResourceIdentifier blueprintResourceId = BlueprintResource.CreateResourceIdentifier(resourceScope, blueprintName);
BlueprintResource blueprint = client.GetBlueprintResource(blueprintResourceId);

// invoke the operation
ArmOperation<BlueprintResource> lro = await blueprint.DeleteAsync(WaitUntil.Completed);
BlueprintResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BlueprintData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription",
    "status": null
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

Code d’état:

204

Définitions

Nom	Description
Blueprint	Représente une définition blueprint.
BlueprintStatus	Status du blueprint. Ce champ est en lecture seule.
BlueprintTargetScope	Étendue dans laquelle cette définition de blueprint peut être affectée.
CloudError
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
ParameterDefinition	Représente un paramètre avec des contraintes et des métadonnées.
ResourceGroupDefinition	Représente un groupe de ressources Azure dans une définition de blueprint.
TemplateParameterType	Types de données autorisés pour Resource Manager paramètres de modèle.

Blueprint

Représente une définition blueprint.

Nom	Type	Description
description	string	Expliquez cette ressource sur plusieurs lignes.
displayName	string	Une chaîne à une ligne explique cette ressource.
id	string	ID de chaîne utilisé pour localiser une ressource sur Azure.
name	string	Nom de cette ressource.
properties.layout	object	Vue de disposition de la définition de blueprint pour référence de l’interface utilisateur.
properties.parameters	<string,  ParameterDefinition>	Paramètres requis par cette définition de blueprint.
properties.resourceGroups	<string,  ResourceGroupDefinition>	Espaces réservés de groupe de ressources définis par cette définition de blueprint.
properties.status	BlueprintStatus	État du blueprint. Ce champ est en lecture seule.
properties.targetScope	BlueprintTargetScope	Étendue dans laquelle cette définition de blueprint peut être affectée.
properties.versions	object	Versions publiées de cette définition de blueprint.
type	string	Type de cette ressource.

BlueprintStatus

Status du blueprint. Ce champ est en lecture seule.

Nom	Type	Description
lastModified	string	Heure de la dernière modification de cette définition de blueprint.
timeCreated	string	Heure de création de cette définition de blueprint.

BlueprintTargetScope

Étendue dans laquelle cette définition de blueprint peut être affectée.

Nom	Type	Description
managementGroup	string	Le blueprint cible un groupe d’administration pendant l’affectation du blueprint. Cette option est réservée à une utilisation ultérieure.
subscription	string	Le blueprint cible un abonnement pendant l’attribution du blueprint.

CloudError

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ParameterDefinition

Représente un paramètre avec des contraintes et des métadonnées.

Nom	Type	Description
allowedValues	AllowedValues[]	Tableau de valeurs autorisées pour ce paramètre.
defaultValue		Valeur par défaut pour ce paramètre.
metadata.description	string	Description de ce paramètre/resourceGroup.
metadata.displayName	string	DisplayName de ce paramètre/resourceGroup.
metadata.strongType	string	StrongType pour l’interface utilisateur pour afficher une expérience riche pendant l’affectation de blueprint. Les types forts pris en charge sont resourceType, principalId et location.
type	TemplateParameterType	Types de données autorisés pour Resource Manager paramètres de modèle.

ResourceGroupDefinition

Représente un groupe de ressources Azure dans une définition de blueprint.

Nom	Type	Description
dependsOn	string[]	Artefacts qui doivent être déployés avant ce groupe de ressources.
location	string	Emplacement de ce resourceGroup. Laissez vide si l’emplacement du groupe de ressources est spécifié pendant l’affectation du blueprint.
metadata.description	string	Description de ce paramètre/resourceGroup.
metadata.displayName	string	DisplayName de ce paramètre/resourceGroup.
metadata.strongType	string	StrongType pour l’interface utilisateur pour afficher une expérience riche pendant l’affectation de blueprint. Les types forts pris en charge sont resourceType, principalId et location.
name	string	Nom de ce resourceGroup. Laissez vide si le nom du groupe de ressources sera spécifié pendant l’affectation du blueprint.
tags	object	Étiquettes à affecter à ce groupe de ressources.

TemplateParameterType

Types de données autorisés pour Resource Manager paramètres de modèle.

Nom	Type	Description
array	string
bool	string
int	string
object	string
secureObject	string
secureString	string
string	string