Freigeben über

Microsoft.Blueprint BlueprintAssignments

  • Artikel

Bicep-Ressourcendefinition

Der BlueprintAssignments-Ressourcentyp 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/blueprintAssignments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
  scope: resourceSymbolicName or scope
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    blueprintId: 'string'
    description: 'string'
    displayName: 'string'
    locks: {
      excludedActions: [
        'string'
      ]
      excludedPrincipals: [
        'string'
      ]
      mode: 'string'
    }
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    resourceGroups: {
      {customized property}: {
        location: 'string'
        name: 'string'
      }
    }
    scope: 'string'
  }
}

Eigenschaftswerte

AssignmentLockSettings

Name Beschreibung Wert
excludedActions Liste der Verwaltungsvorgänge, die von Blueprintsperren ausgeschlossen sind. Bis zu 200 Aktionen sind zulässig. Wenn der Sperrmodus auf "AllResourcesReadOnly" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" und "Microsoft.Authorization/locks/delete". Wenn der Sperrmodus auf "AllResourcesDoNotDelete" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "Microsoft.Authorization/locks/delete". Doppelte Aktionen werden entfernt. string[]
excludedPrincipals Liste der AAD-Prinzipale, die von Blueprintsperren ausgeschlossen sind. Bis zu 5 Prinzipale sind zulässig. string[]
Modus Sperrmodus. 'AllResourcesDoNotDelete'
"AllResourcesReadOnly"
'None'

AssignmentProperties

Name Beschreibung Wert
blueprintId ID der veröffentlichten Version einer Blueprintdefinition. Schnur
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 =
Schlösser Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden. AssignmentLockSettings
Parameter Werte des Blueprint-Zuordnungsparameters. AssignmentPropertiesParameters (erforderlich)
resourceGroups Namen und Speicherorte von Platzhaltern für Ressourcengruppen. AssignmentPropertiesResourceGroups (erforderlich)
Umfang Der Zielabonnementbereich der Blueprintzuweisung (Format: '/subscriptions/{subscriptionId}'). Für Zuordnungen auf Verwaltungsgruppenebene ist die Eigenschaft erforderlich. Schnur

AssignmentPropertiesParameters

Name Beschreibung Wert

AssignmentPropertiesResourceGroups

Name Beschreibung Wert

KeyVaultReference

Name Beschreibung Wert
id Azure-Ressourcen-ID des Key Vault. Zeichenfolge (erforderlich)

ManagedServiceIdentity

Name Beschreibung Wert
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur
tenantId ID des Azure Active Directory. Schnur
Art Typ der verwalteten Identität. 'None'
'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentities Die Liste der vom Benutzer zugewiesenen verwalteten Identitäten, die der Ressource zugeordnet sind. Der Schlüssel ist die Azure-Ressourcen-ID der verwalteten Identität. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.Blueprint/blueprintAssignments

Name Beschreibung Wert
Identität Verwaltete Identität für diese Blaupausenzuweisung. ManagedServiceIdentity- (erforderlich)
Ort Der Speicherort dieser Blaupausenzuweisung. Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften für das Blueprint-Zuordnungsobjekt. AssignmentProperties- (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.

ParameterValue

Name Beschreibung Wert
Referenz Parameterwert als Bezugstyp. SecretValueReference
Wert Parameterwert. Jeder gültige JSON-Wert ist zulässig, einschließlich Objekte, Arrays, Zeichenfolgen, Zahlen und Booleans. jegliche

ResourceGroupValue

Name Beschreibung Wert
Ort Speicherort der Ressourcengruppe. Schnur
Name Name der Ressourcengruppe. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1

SecretValueReference

Name Beschreibung Wert
keyVault Gibt den Verweis auf einen bestimmten Azure Key Vault an. KeyVaultReference- (erforderlich)
secretName Der Name des geheimen Schlüssels. Zeichenfolge (erforderlich)
secretVersion Die zu verwendende Version des geheimen Schlüssels. Wenn sie leer gelassen wird, wird die neueste Version des geheimen Schlüssels verwendet. Schnur

UserAssignedIdentity

Name Beschreibung Wert
clientId Dieser Identität zugeordnete Client-App-ID. Schnur
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur

ARM-Vorlagenressourcendefinition

Der BlueprintAssignments-Ressourcentyp 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/blueprintAssignments-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Blueprint/blueprintAssignments",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "blueprintId": "string",
    "description": "string",
    "displayName": "string",
    "locks": {
      "excludedActions": [ "string" ],
      "excludedPrincipals": [ "string" ],
      "mode": "string"
    },
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "resourceGroups": {
      "{customized property}": {
        "location": "string",
        "name": "string"
      }
    },
    "scope": "string"
  }
}

Eigenschaftswerte

AssignmentLockSettings

Name Beschreibung Wert
excludedActions Liste der Verwaltungsvorgänge, die von Blueprintsperren ausgeschlossen sind. Bis zu 200 Aktionen sind zulässig. Wenn der Sperrmodus auf "AllResourcesReadOnly" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" und "Microsoft.Authorization/locks/delete". Wenn der Sperrmodus auf "AllResourcesDoNotDelete" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "Microsoft.Authorization/locks/delete". Doppelte Aktionen werden entfernt. string[]
excludedPrincipals Liste der AAD-Prinzipale, die von Blueprintsperren ausgeschlossen sind. Bis zu 5 Prinzipale sind zulässig. string[]
Modus Sperrmodus. 'AllResourcesDoNotDelete'
"AllResourcesReadOnly"
'None'

AssignmentProperties

Name Beschreibung Wert
blueprintId ID der veröffentlichten Version einer Blueprintdefinition. Schnur
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 =
Schlösser Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden. AssignmentLockSettings
Parameter Werte des Blueprint-Zuordnungsparameters. AssignmentPropertiesParameters (erforderlich)
resourceGroups Namen und Speicherorte von Platzhaltern für Ressourcengruppen. AssignmentPropertiesResourceGroups (erforderlich)
Umfang Der Zielabonnementbereich der Blueprintzuweisung (Format: '/subscriptions/{subscriptionId}'). Für Zuordnungen auf Verwaltungsgruppenebene ist die Eigenschaft erforderlich. Schnur

AssignmentPropertiesParameters

Name Beschreibung Wert

AssignmentPropertiesResourceGroups

Name Beschreibung Wert

KeyVaultReference

Name Beschreibung Wert
id Azure-Ressourcen-ID des Key Vault. Zeichenfolge (erforderlich)

ManagedServiceIdentity

Name Beschreibung Wert
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur
tenantId ID des Azure Active Directory. Schnur
Art Typ der verwalteten Identität. 'None'
'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentities Die Liste der vom Benutzer zugewiesenen verwalteten Identitäten, die der Ressource zugeordnet sind. Der Schlüssel ist die Azure-Ressourcen-ID der verwalteten Identität. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.Blueprint/blueprintAssignments

Name Beschreibung Wert
apiVersion Die API-Version "2018-11-01-preview"
Identität Verwaltete Identität für diese Blaupausenzuweisung. ManagedServiceIdentity- (erforderlich)
Ort Der Speicherort dieser Blaupausenzuweisung. Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften für das Blueprint-Zuordnungsobjekt. AssignmentProperties- (erforderlich)
Art Der Ressourcentyp "Microsoft.Blueprint/blueprintAssignments"

ParameterValue

Name Beschreibung Wert
Referenz Parameterwert als Bezugstyp. SecretValueReference
Wert Parameterwert. Jeder gültige JSON-Wert ist zulässig, einschließlich Objekte, Arrays, Zeichenfolgen, Zahlen und Booleans. jegliche

ResourceGroupValue

Name Beschreibung Wert
Ort Speicherort der Ressourcengruppe. Schnur
Name Name der Ressourcengruppe. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1

SecretValueReference

Name Beschreibung Wert
keyVault Gibt den Verweis auf einen bestimmten Azure Key Vault an. KeyVaultReference- (erforderlich)
secretName Der Name des geheimen Schlüssels. Zeichenfolge (erforderlich)
secretVersion Die zu verwendende Version des geheimen Schlüssels. Wenn sie leer gelassen wird, wird die neueste Version des geheimen Schlüssels verwendet. Schnur

UserAssignedIdentity

Name Beschreibung Wert
clientId Dieser Identität zugeordnete Client-App-ID. Schnur
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der BlueprintAssignments-Ressourcentyp 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/blueprintAssignments-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"
  name = "string"
  parent_id = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      blueprintId = "string"
      description = "string"
      displayName = "string"
      locks = {
        excludedActions = [
          "string"
        ]
        excludedPrincipals = [
          "string"
        ]
        mode = "string"
      }
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      resourceGroups = {
        {customized property} = {
          location = "string"
          name = "string"
        }
      }
      scope = "string"
    }
  })
}

Eigenschaftswerte

AssignmentLockSettings

Name Beschreibung Wert
excludedActions Liste der Verwaltungsvorgänge, die von Blueprintsperren ausgeschlossen sind. Bis zu 200 Aktionen sind zulässig. Wenn der Sperrmodus auf "AllResourcesReadOnly" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" und "Microsoft.Authorization/locks/delete". Wenn der Sperrmodus auf "AllResourcesDoNotDelete" festgelegt ist, werden die folgenden Aktionen automatisch an "excludedActions" angefügt: "Microsoft.Authorization/locks/delete". Doppelte Aktionen werden entfernt. string[]
excludedPrincipals Liste der AAD-Prinzipale, die von Blueprintsperren ausgeschlossen sind. Bis zu 5 Prinzipale sind zulässig. string[]
Modus Sperrmodus. 'AllResourcesDoNotDelete'
"AllResourcesReadOnly"
'None'

AssignmentProperties

Name Beschreibung Wert
blueprintId ID der veröffentlichten Version einer Blueprintdefinition. Schnur
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 =
Schlösser Definiert, wie Ressourcen, die von einer Blueprintzuordnung bereitgestellt werden, gesperrt werden. AssignmentLockSettings
Parameter Werte des Blueprint-Zuordnungsparameters. AssignmentPropertiesParameters (erforderlich)
resourceGroups Namen und Speicherorte von Platzhaltern für Ressourcengruppen. AssignmentPropertiesResourceGroups (erforderlich)
Umfang Der Zielabonnementbereich der Blueprintzuweisung (Format: '/subscriptions/{subscriptionId}'). Für Zuordnungen auf Verwaltungsgruppenebene ist die Eigenschaft erforderlich. Schnur

AssignmentPropertiesParameters

Name Beschreibung Wert

AssignmentPropertiesResourceGroups

Name Beschreibung Wert

KeyVaultReference

Name Beschreibung Wert
id Azure-Ressourcen-ID des Key Vault. Zeichenfolge (erforderlich)

ManagedServiceIdentity

Name Beschreibung Wert
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur
tenantId ID des Azure Active Directory. Schnur
Art Typ der verwalteten Identität. 'None'
'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentities Die Liste der vom Benutzer zugewiesenen verwalteten Identitäten, die der Ressource zugeordnet sind. Der Schlüssel ist die Azure-Ressourcen-ID der verwalteten Identität. ManagedServiceIdentityUserAssignedIdentities-

ManagedServiceIdentityUserAssignedIdentities

Name Beschreibung Wert

Microsoft.Blueprint/blueprintAssignments

Name Beschreibung Wert
Identität Verwaltete Identität für diese Blaupausenzuweisung. ManagedServiceIdentity- (erforderlich)
Ort Der Speicherort dieser Blaupausenzuweisung. Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften für das Blueprint-Zuordnungsobjekt. AssignmentProperties- (erforderlich)
Art Der Ressourcentyp "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"

ParameterValue

Name Beschreibung Wert
Referenz Parameterwert als Bezugstyp. SecretValueReference
Wert Parameterwert. Jeder gültige JSON-Wert ist zulässig, einschließlich Objekte, Arrays, Zeichenfolgen, Zahlen und Booleans. jegliche

ResourceGroupValue

Name Beschreibung Wert
Ort Speicherort der Ressourcengruppe. Schnur
Name Name der Ressourcengruppe. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1

SecretValueReference

Name Beschreibung Wert
keyVault Gibt den Verweis auf einen bestimmten Azure Key Vault an. KeyVaultReference- (erforderlich)
secretName Der Name des geheimen Schlüssels. Zeichenfolge (erforderlich)
secretVersion Die zu verwendende Version des geheimen Schlüssels. Wenn sie leer gelassen wird, wird die neueste Version des geheimen Schlüssels verwendet. Schnur

UserAssignedIdentity

Name Beschreibung Wert
clientId Dieser Identität zugeordnete Client-App-ID. Schnur
principalId Azure Active Directory-Prinzipal-ID, die dieser Identität zugeordnet ist. Schnur