Freigeben über


Microsoft.Blueprint Blueprints 2018-11-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp "Blueprints" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Blueprint/Blueprints-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Blueprint/blueprints@2018-11-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    parameters: {
      {customized property}: {
        allowedValues: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        metadata: {
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        type: 'string'
      }
    }
    resourceGroups: {
      {customized property}: {
        dependsOn: [
          'string'
        ]
        location: 'string'
        metadata: {
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        name: 'string'
        tags: {
          {customized property}: 'string'
        }
      }
    }
    targetScope: 'string'
    versions: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

Eigenschaftswerte

BlueprintProperties

Name Beschreibung Wert
Beschreibung Mehrzeilige Erläuterung dieser Ressource. Schnur

Zwänge:
Max. Länge =
displayName Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert. Schnur

Zwänge:
Max. Länge =
Parameter Parameter, die von dieser Blueprintdefinition benötigt werden. SharedBlueprintPropertiesParameters
resourceGroups Durch diese Blueprintdefinition definierte Platzhalter für Ressourcengruppen. SharedBlueprintPropertiesResourceGroups
targetScope Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann. 'managementGroup'
"Abonnement"
Versionen Veröffentlichte Versionen dieser Blueprintdefinition. jegliche

Microsoft.Blueprint/Blueprints

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Detaillierte Eigenschaften für die Blaupausendefinition. BlueprintProperties- (erforderlich)
Umfang Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.

ParameterDefinition

Name Beschreibung Wert
allowedValues Array zulässiger Werte für diesen Parameter. any[]
defaultValue Standardwert für diesen Parameter. jegliche
Metadaten Benutzerfreundliche Eigenschaften für diesen Parameter. ParameterDefinitionMetadata-
Art Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter. 'Array'
'bool'
"int"
'object'
"secureObject"
"secureString"
"string" (erforderlich)

ParameterDefinitionMetadata

Name Beschreibung Wert
Beschreibung Beschreibung dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
displayName DisplayName dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
strongType StrongType für ui zum Rendern umfangreicher Erfahrungen während der Blueprint-Zuordnung. Unterstützte starke Typen sind "resourceType", "principalId" und "location". Schnur

Zwänge:
Max. Länge =

ResourceGroupDefinition

Name Beschreibung Wert
dependsOn Artefakte, die vor dieser Ressourcengruppe bereitgestellt werden müssen. string[]
Ort Speicherort dieser resourceGroup. Lassen Sie leer, wenn der Speicherort der Ressourcengruppe während der Blueprintzuordnung angegeben wird. Schnur
Metadaten Benutzerfreundliche Eigenschaften für diese Ressourcengruppe. ParameterDefinitionMetadata-
Name Name dieser resourceGroup. Lassen Sie leer, wenn der Ressourcengruppenname während der Blueprintzuordnung angegeben wird. Schnur
Schilder Tags, die dieser Ressourcengruppe zugewiesen werden sollen. ResourceGroupDefinitionTags-

ResourceGroupDefinitionTags

Name Beschreibung Wert

SharedBlueprintPropertiesParameters

Name Beschreibung Wert

SharedBlueprintPropertiesResourceGroups

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Blueprints" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Blueprint/Blueprints-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Blueprint/blueprints",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "type": "string"
      }
    },
    "resourceGroups": {
      "{customized property}": {
        "dependsOn": [ "string" ],
        "location": "string",
        "metadata": {
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "name": "string",
        "tags": {
          "{customized property}": "string"
        }
      }
    },
    "targetScope": "string",
    "versions": {}
  }
}

Eigenschaftswerte

BlueprintProperties

Name Beschreibung Wert
Beschreibung Mehrzeilige Erläuterung dieser Ressource. Schnur

Zwänge:
Max. Länge =
displayName Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert. Schnur

Zwänge:
Max. Länge =
Parameter Parameter, die von dieser Blueprintdefinition benötigt werden. SharedBlueprintPropertiesParameters
resourceGroups Durch diese Blueprintdefinition definierte Platzhalter für Ressourcengruppen. SharedBlueprintPropertiesResourceGroups
targetScope Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann. 'managementGroup'
"Abonnement"
Versionen Veröffentlichte Versionen dieser Blueprintdefinition. jegliche

Microsoft.Blueprint/Blueprints

Name Beschreibung Wert
apiVersion Die API-Version "2018-11-01-preview"
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Detaillierte Eigenschaften für die Blaupausendefinition. BlueprintProperties- (erforderlich)
Art Der Ressourcentyp "Microsoft.Blueprint/Blueprints"

ParameterDefinition

Name Beschreibung Wert
allowedValues Array zulässiger Werte für diesen Parameter. any[]
defaultValue Standardwert für diesen Parameter. jegliche
Metadaten Benutzerfreundliche Eigenschaften für diesen Parameter. ParameterDefinitionMetadata-
Art Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter. 'Array'
'bool'
"int"
'object'
"secureObject"
"secureString"
"string" (erforderlich)

ParameterDefinitionMetadata

Name Beschreibung Wert
Beschreibung Beschreibung dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
displayName DisplayName dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
strongType StrongType für ui zum Rendern umfangreicher Erfahrungen während der Blueprint-Zuordnung. Unterstützte starke Typen sind "resourceType", "principalId" und "location". Schnur

Zwänge:
Max. Länge =

ResourceGroupDefinition

Name Beschreibung Wert
dependsOn Artefakte, die vor dieser Ressourcengruppe bereitgestellt werden müssen. string[]
Ort Speicherort dieser resourceGroup. Lassen Sie leer, wenn der Speicherort der Ressourcengruppe während der Blueprintzuordnung angegeben wird. Schnur
Metadaten Benutzerfreundliche Eigenschaften für diese Ressourcengruppe. ParameterDefinitionMetadata-
Name Name dieser resourceGroup. Lassen Sie leer, wenn der Ressourcengruppenname während der Blueprintzuordnung angegeben wird. Schnur
Schilder Tags, die dieser Ressourcengruppe zugewiesen werden sollen. ResourceGroupDefinitionTags-

ResourceGroupDefinitionTags

Name Beschreibung Wert

SharedBlueprintPropertiesParameters

Name Beschreibung Wert

SharedBlueprintPropertiesResourceGroups

Name Beschreibung Wert

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Blueprints – Erstellen einer neuen Blueprintdefinition

Bereitstellen in Azure
Diese Vorlage erstellt eine Azure Blueprint-Blueprintdefinition. Die Blueprintdefinition enthält ein Richtlinienzuweisungsartefakt und kann geändert und dann in Verwaltungsgruppen oder Abonnements für konsistente Umgebungen bereitgestellt werden.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Blueprints" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Blueprint/Blueprints-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          type = "string"
        }
      }
      resourceGroups = {
        {customized property} = {
          dependsOn = [
            "string"
          ]
          location = "string"
          metadata = {
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          name = "string"
          tags = {
            {customized property} = "string"
          }
        }
      }
      targetScope = "string"
      versions = ?
    }
  })
}

Eigenschaftswerte

BlueprintProperties

Name Beschreibung Wert
Beschreibung Mehrzeilige Erläuterung dieser Ressource. Schnur

Zwänge:
Max. Länge =
displayName Diese Ressource wird durch eine einzeilige Zeichenfolge erläutert. Schnur

Zwänge:
Max. Länge =
Parameter Parameter, die von dieser Blueprintdefinition benötigt werden. SharedBlueprintPropertiesParameters
resourceGroups Durch diese Blueprintdefinition definierte Platzhalter für Ressourcengruppen. SharedBlueprintPropertiesResourceGroups
targetScope Der Bereich, in dem diese Blueprintdefinition zugewiesen werden kann. 'managementGroup'
"Abonnement"
Versionen Veröffentlichte Versionen dieser Blueprintdefinition. jegliche

Microsoft.Blueprint/Blueprints

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Detaillierte Eigenschaften für die Blaupausendefinition. BlueprintProperties- (erforderlich)
Art Der Ressourcentyp "Microsoft.Blueprint/blueprints@2018-11-01-preview"

ParameterDefinition

Name Beschreibung Wert
allowedValues Array zulässiger Werte für diesen Parameter. any[]
defaultValue Standardwert für diesen Parameter. jegliche
Metadaten Benutzerfreundliche Eigenschaften für diesen Parameter. ParameterDefinitionMetadata-
Art Zulässige Datentypen für Ressourcen-Manager-Vorlagenparameter. 'Array'
'bool'
"int"
'object'
"secureObject"
"secureString"
"string" (erforderlich)

ParameterDefinitionMetadata

Name Beschreibung Wert
Beschreibung Beschreibung dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
displayName DisplayName dieses Parameters/resourceGroup. Schnur

Zwänge:
Max. Länge =
strongType StrongType für ui zum Rendern umfangreicher Erfahrungen während der Blueprint-Zuordnung. Unterstützte starke Typen sind "resourceType", "principalId" und "location". Schnur

Zwänge:
Max. Länge =

ResourceGroupDefinition

Name Beschreibung Wert
dependsOn Artefakte, die vor dieser Ressourcengruppe bereitgestellt werden müssen. string[]
Ort Speicherort dieser resourceGroup. Lassen Sie leer, wenn der Speicherort der Ressourcengruppe während der Blueprintzuordnung angegeben wird. Schnur
Metadaten Benutzerfreundliche Eigenschaften für diese Ressourcengruppe. ParameterDefinitionMetadata-
Name Name dieser resourceGroup. Lassen Sie leer, wenn der Ressourcengruppenname während der Blueprintzuordnung angegeben wird. Schnur
Schilder Tags, die dieser Ressourcengruppe zugewiesen werden sollen. ResourceGroupDefinitionTags-

ResourceGroupDefinitionTags

Name Beschreibung Wert

SharedBlueprintPropertiesParameters

Name Beschreibung Wert

SharedBlueprintPropertiesResourceGroups

Name Beschreibung Wert