Aracılığıyla paylaş

Blueprints - Get

  • Başvuru
Service:
Blueprints
API Version:
2018-11-01-preview

Şema tanımını alın.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
blueprintName
 path True

string

Şema tanımının adı.
resourceScope
 path True

string

Kaynağın kapsamı. Geçerli kapsamlar şunlardır: yönetim grubu (biçim: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), abonelik (biçim: '/subscriptions/{subscriptionId}').
api-version
 query True

string

İstemci API Sürümü.

Yanıtlar

Name Tür Description
200 OK

Blueprint

Tamam -- şema tanımı alındı.
Other Status Codes

CloudError

Şemalar hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

ManagementGroupBlueprint
SubscriptionBlueprint

ManagementGroupBlueprint

Sample Request

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

Sample Response

Status code:
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"
}

SubscriptionBlueprint

Sample Request

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

Sample Response

Status code:
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"
}

Tanımlar

Name Description
Blueprint

Şema tanımını temsil eder.
BlueprintStatus

Şemanın durumu. Bu alan salt okunur.
BlueprintTargetScope

Bu şema tanımının atanabileceği kapsam.
CloudError
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.
ErrorResponse

Hata Yanıtı
ParameterDefinition

Bir parametreyi kısıtlar ve meta verilerle temsil eder.
ResourceGroupDefinition

Şema tanımındaki bir Azure kaynak grubunu temsil eder.
TemplateParameterType

Resource Manager şablonu parametreleri için izin verilen veri türleri.

Blueprint

Şema tanımını temsil eder.

Name Tür Description
description

string

Bu kaynağı çok satırlı olarak açıklayın.
displayName

string

Tek satırlık dize bu kaynağı açıklar.
id

string

Azure'da herhangi bir kaynağı bulmak için kullanılan dize kimliği.
name

string

Bu kaynağın adı.
properties.layout

object

Kullanıcı arabirimi başvurusu için şema tanımının düzen görünümü.
properties.parameters

<string,  ParameterDefinition>

Bu şema tanımı için gereken parametreler.
properties.resourceGroups

<string,  ResourceGroupDefinition>

Bu şema tanımı tarafından tanımlanan kaynak grubu yer tutucuları.
properties.status

BlueprintStatus

Şemanın durumu. Bu alan salt okunur.
properties.targetScope

BlueprintTargetScope

Bu şema tanımının atanabileceği kapsam.
properties.versions

object

Bu şema tanımının yayımlanmış sürümleri.
type

string

Bu kaynağın türü.

BlueprintStatus

Şemanın durumu. Bu alan salt okunur.

Name Tür Description
lastModified

string

Bu şema tanımının son değiştirilme zamanı.
timeCreated

string

Bu şema tanımının oluşturulma zamanı.

BlueprintTargetScope

Bu şema tanımının atanabileceği kapsam.

Name Tür Description
managementGroup

string

Şema, şema ataması sırasında bir yönetim grubunu hedefler. Bu, gelecekte kullanılmak üzere ayrılmıştır.
subscription

string

Şema, şema ataması sırasında aboneliği hedefler.

CloudError

Name Tür Description
error

ErrorResponse

Hata Yanıtı
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorResponse

Hata Yanıtı

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.
code

string

Hata kodu.
details

ErrorResponse[]

Hata ayrıntıları.
message

string

Hata iletisi.
target

string

Hata hedefi.

ParameterDefinition

Bir parametreyi kısıtlar ve meta verilerle temsil eder.

Name Tür Description
allowedValues

AllowedValues[]

Bu parametre için izin verilen değerler dizisi.
defaultValue

Bu parametre için varsayılan Değer.
metadata.description

string

Bu parametrenin/resourceGroup'un açıklaması.
metadata.displayName

string

Bu parametrenin/resourceGroup'un DisplayName'i.
metadata.strongType

string

Şema ataması sırasında zengin deneyim oluşturmak için kullanıcı arabirimi için StrongType. Desteklenen güçlü türler resourceType, principalId ve konumdur.
type

TemplateParameterType

Resource Manager şablonu parametreleri için izin verilen veri türleri.

ResourceGroupDefinition

Şema tanımındaki bir Azure kaynak grubunu temsil eder.

Name Tür Description
dependsOn

string[]

Bu kaynak grubundan önce dağıtılması gereken yapıtlar.
location

string

Bu resourceGroup'un konumu. Şema ataması sırasında kaynak grubu konumu belirtilecekse boş bırakın.
metadata.description

string

Bu parametrenin/resourceGroup'un açıklaması.
metadata.displayName

string

Bu parametrenin/resourceGroup'un DisplayName'i.
metadata.strongType

string

Şema ataması sırasında zengin deneyim oluşturmak için kullanıcı arabirimi için StrongType. Desteklenen güçlü türler resourceType, principalId ve konumdur.
name

string

Bu resourceGroup'un adı. Şema ataması sırasında kaynak grubu adı belirtilecekse boş bırakın.
tags

object

Bu kaynak grubuna atanacak etiketler.

TemplateParameterType

Resource Manager şablonu parametreleri için izin verilen veri türleri.

Name Tür Description
array

string

bool

string

int

string

object

string

secureObject

string

secureString

string

string

string