Dela via


Microsoft.Blueprint-skisser

Bicep-resursdefinition

Skissresurstypen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Blueprint/blueprints-resurs lägger du till följande Bicep i mallen.

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)
  }
}

Egenskapsvärden

BlueprintProperties

Namn Beskrivning Värde
beskrivning Förklara den här resursen med flera rader. sträng

Begränsningar:
Maxlängd = 500
displayName Enradssträng förklarar den här resursen. sträng

Begränsningar:
Max längd = 256
Parametrar Parametrar som krävs av den här skissdefinitionen. SharedBlueprintPropertiesParameters
resourceGroups Platshållare för resursgrupper som definieras av den här skissdefinitionen. SharedBlueprintPropertiesResourceGroups
targetScope Omfånget där den här skissdefinitionen kan tilldelas. "managementGroup"
"prenumeration"
Versioner Publicerade versioner av den här skissdefinitionen. någon

Microsoft.Blueprint/blueprints

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
Egenskaper Detaljerade egenskaper för skissdefinition. BlueprintProperties (krävs)
omfattning Använd när du skapar en resurs i ett annat omfång än distributionsomfånget. Ange den här egenskapen till det symboliska namnet på en resurs för att tillämpa -tilläggsresursen.

ParameterDefinition

Namn Beskrivning Värde
allowedValues Matris med tillåtna värden för den här parametern. any[]
defaultValue Standardvärde för den här parametern. någon
metadata Användarvänliga egenskaper för den här parametern. ParameterDefinitionMetadata
typ Tillåtna datatyper för Resource Manager-mallparametrar. "matris"
"bool"
"int"
"objekt"
"secureObject"
"secureString"
"string" (krävs)

ParameterDefinitionMetadata

Namn Beskrivning Värde
beskrivning Beskrivning av den här parametern/resourceGroup. sträng

Begränsningar:
Maxlängd = 500
displayName DisplayName för den här parametern/resourceGroup. sträng

Begränsningar:
Max längd = 256
strongType StrongType för användargränssnittet för att återge en omfattande upplevelse under skisstilldelningen. Starka typer som stöds är resourceType, principalId och plats. sträng

Begränsningar:
Maximal längd = 64

ResourceGroupDefinition

Namn Beskrivning Värde
dependsOn Artefakter som måste distribueras före den här resursgruppen. string[]
plats Plats för den här resourceGroup. Lämna tomt om resursgruppens plats anges under skisstilldelningen. sträng
metadata Användarvänliga egenskaper för den här resursgruppen. ParameterDefinitionMetadata
Namn Namnet på den här resourceGroup. Lämna tomt om resursgruppens namn anges under skisstilldelningen. sträng
Taggar Taggar som ska tilldelas till den här resursgruppen. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Namn Beskrivning Värde

SharedBlueprintPropertiesParameters

Namn Beskrivning Värde

SharedBlueprintPropertiesResourceGroups

Namn Beskrivning Värde

Resursdefinition för ARM-mall

Skissresurstypen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Blueprint/blueprints-resurs lägger du till följande JSON i mallen.

{
  "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": {}
  }
}

Egenskapsvärden

BlueprintProperties

Namn Beskrivning Värde
beskrivning Förklara den här resursen med flera rader. sträng

Begränsningar:
Maxlängd = 500
displayName Enradssträng förklarar den här resursen. sträng

Begränsningar:
Max längd = 256
Parametrar Parametrar som krävs av den här skissdefinitionen. SharedBlueprintPropertiesParameters
resourceGroups Platshållare för resursgrupper som definieras av den här skissdefinitionen. SharedBlueprintPropertiesResourceGroups
targetScope Omfånget där den här skissdefinitionen kan tilldelas. "managementGroup"
"prenumeration"
Versioner Publicerade versioner av den här skissdefinitionen. någon

Microsoft.Blueprint/blueprints

Namn Beskrivning Värde
apiVersion API-versionen "2018-11-01-preview"
Namn Resursnamnet sträng (krävs)
Egenskaper Detaljerade egenskaper för skissdefinition. BlueprintProperties (krävs)
typ Resurstypen "Microsoft.Blueprint/blueprints"

ParameterDefinition

Namn Beskrivning Värde
allowedValues Matris med tillåtna värden för den här parametern. any[]
defaultValue Standardvärde för den här parametern. någon
metadata Användarvänliga egenskaper för den här parametern. ParameterDefinitionMetadata
typ Tillåtna datatyper för Resource Manager-mallparametrar. "matris"
"bool"
"int"
"objekt"
"secureObject"
"secureString"
"string" (krävs)

ParameterDefinitionMetadata

Namn Beskrivning Värde
beskrivning Beskrivning av den här parametern/resourceGroup. sträng

Begränsningar:
Maxlängd = 500
displayName DisplayName för den här parametern/resourceGroup. sträng

Begränsningar:
Max längd = 256
strongType StrongType för användargränssnittet för att återge en omfattande upplevelse under skisstilldelningen. Starka typer som stöds är resourceType, principalId och plats. sträng

Begränsningar:
Maximal längd = 64

ResourceGroupDefinition

Namn Beskrivning Värde
dependsOn Artefakter som måste distribueras före den här resursgruppen. string[]
plats Plats för den här resourceGroup. Lämna tomt om resursgruppens plats anges under skisstilldelningen. sträng
metadata Användarvänliga egenskaper för den här resursgruppen. ParameterDefinitionMetadata
Namn Namnet på den här resourceGroup. Lämna tomt om resursgruppens namn anges under skisstilldelningen. sträng
Taggar Taggar som ska tilldelas till den här resursgruppen. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Namn Beskrivning Värde

SharedBlueprintPropertiesParameters

Namn Beskrivning Värde

SharedBlueprintPropertiesResourceGroups

Namn Beskrivning Värde

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skisser – Skapa en ny skissdefinition

Distribuera till Azure
Den här mallen skapar en Skissdefinition för Azure Blueprint. Skissdefinitionen innehåller en principtilldelningsartefakt och kan ändras och sedan distribueras till hanteringsgrupper eller prenumerationer för konsekventa miljöer.

Resursdefinition för Terraform (AzAPI-provider)

Skissresurstypen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Blueprint/blueprints-resurs lägger du till följande Terraform i mallen.

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 = ?
    }
  })
}

Egenskapsvärden

BlueprintProperties

Namn Beskrivning Värde
beskrivning Förklara den här resursen med flera rader. sträng

Begränsningar:
Maxlängd = 500
displayName Enradssträng förklarar den här resursen. sträng

Begränsningar:
Max längd = 256
Parametrar Parametrar som krävs av den här skissdefinitionen. SharedBlueprintPropertiesParameters
resourceGroups Platshållare för resursgrupper som definieras av den här skissdefinitionen. SharedBlueprintPropertiesResourceGroups
targetScope Omfånget där den här skissdefinitionen kan tilldelas. "managementGroup"
"prenumeration"
Versioner Publicerade versioner av den här skissdefinitionen. någon

Microsoft.Blueprint/blueprints

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
parent_id ID:t för resursen som den här tilläggsresursen ska tillämpas på. sträng (krävs)
Egenskaper Detaljerade egenskaper för skissdefinition. BlueprintProperties (krävs)
typ Resurstypen "Microsoft.Blueprint/blueprints@2018-11-01-preview"

ParameterDefinition

Namn Beskrivning Värde
allowedValues Matris med tillåtna värden för den här parametern. any[]
defaultValue Standardvärde för den här parametern. någon
metadata Användarvänliga egenskaper för den här parametern. ParameterDefinitionMetadata
typ Tillåtna datatyper för Resource Manager-mallparametrar. "matris"
"bool"
"int"
"objekt"
"secureObject"
"secureString"
"string" (krävs)

ParameterDefinitionMetadata

Namn Beskrivning Värde
beskrivning Beskrivning av den här parametern/resourceGroup. sträng

Begränsningar:
Maxlängd = 500
displayName DisplayName för den här parametern/resourceGroup. sträng

Begränsningar:
Max längd = 256
strongType StrongType för användargränssnittet för att återge en omfattande upplevelse under skisstilldelningen. Starka typer som stöds är resourceType, principalId och plats. sträng

Begränsningar:
Maximal längd = 64

ResourceGroupDefinition

Namn Beskrivning Värde
dependsOn Artefakter som måste distribueras före den här resursgruppen. string[]
plats Plats för den här resourceGroup. Lämna tomt om resursgruppens plats anges under skisstilldelningen. sträng
metadata Användarvänliga egenskaper för den här resursgruppen. ParameterDefinitionMetadata
Namn Namnet på den här resourceGroup. Lämna tomt om resursgruppens namn anges under skisstilldelningen. sträng
Taggar Taggar som ska tilldelas till den här resursgruppen. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Namn Beskrivning Värde

SharedBlueprintPropertiesParameters

Namn Beskrivning Värde

SharedBlueprintPropertiesResourceGroups

Namn Beskrivning Värde