Dela via


Microsoft.Blueprint blueprintAssignments

Bicep-resursdefinition

Resurstypen blueprintAssignments 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/blueprintAssignments-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

AssignmentLockSettings

Namn Beskrivning Värde
excludedActions Lista över hanteringsåtgärder som undantas från skisslås. Upp till 200 åtgärder är tillåtna. Om låsläget är inställt på "AllResourcesReadOnly" läggs följande åtgärder automatiskt till i "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" och "Microsoft.Authorization/locks/delete". Om låsläget är inställt på "AllResourcesDoNotDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamn som undantas från skisslås. Upp till 5 huvudkonton är tillåtna. string[]
läge Låsläge. "AllResourcesDoNotDelete"
"AllResourcesReadOnly"
"Ingen"

TilldelningEgenskaper

Namn Beskrivning Värde
blueprintId ID för den publicerade versionen av en skissdefinition. sträng
beskrivning Förklara den här resursen med flera rader. sträng

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

Begränsningar:
Max längd =
Lås Definierar hur resurser som distribueras av en skisstilldelning är låsta. AssignmentLockSettings
Parametrar Parametervärden för skisstilldelning. AssignmentPropertiesParameters (krävs)
resourceGroups Namn och platser för platshållare för resursgrupper. AssignmentPropertiesResourceGroups (krävs)
omfattning Skisstilldelningens målprenumerationsomfång (format: '/subscriptions/{subscriptionId}'). För tilldelningar på hanteringsgruppsnivå krävs egenskapen. sträng

AssignmentPropertiesParameters

Namn Beskrivning Värde

AssignmentPropertiesResourceGroups

Namn Beskrivning Värde

KeyVaultReference

Namn Beskrivning Värde
Id Azure-resurs-ID för Key Vault. sträng (krävs)

ManagedServiceIdentity

Namn Beskrivning Värde
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng
tenantId ID för Azure Active Directory. sträng
typ Typ av hanterad identitet. "Ingen"
"SystemAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Listan över användartilldelade hanterade identiteter som är associerade med resursen. Nyckeln är Azure-resurs-ID för den hanterade identiteten. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.Blueprint/blueprintAssignments

Namn Beskrivning Värde
identitet Hanterad identitet för den här skisstilldelningen. ManagedServiceIdentity (krävs)
plats Platsen för den här skisstilldelningen. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för skisstilldelningsobjekt. AssignmentProperties (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.

ParameterValue

Namn Beskrivning Värde
hänvisning Parametervärde som referenstyp. SecretValueReference
värde Parametervärde. Alla giltiga JSON-värden tillåts, inklusive objekt, matriser, strängar, tal och booleska värden. någon

ResourceGroupValue

Namn Beskrivning Värde
plats Plats för resursgruppen. sträng
Namn Namnet på resursgruppen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1

SecretValueReference

Namn Beskrivning Värde
keyVault Anger referensen till ett visst Azure Key Vault. KeyVaultReference (krävs)
secretName Namnet på hemligheten. sträng (krävs)
secretVersion Den version av hemligheten som ska användas. Om den lämnas tom används den senaste versionen av hemligheten. sträng

UserAssignedIdentity

Namn Beskrivning Värde
clientId Klientapp-ID som är associerat med den här identiteten. sträng
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng

Resursdefinition för ARM-mall

Resurstypen blueprintAssignments 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/blueprintAssignments-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

AssignmentLockSettings

Namn Beskrivning Värde
excludedActions Lista över hanteringsåtgärder som undantas från skisslås. Upp till 200 åtgärder är tillåtna. Om låsläget är inställt på "AllResourcesReadOnly" läggs följande åtgärder automatiskt till i "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" och "Microsoft.Authorization/locks/delete". Om låsläget är inställt på "AllResourcesDoNotDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamn som undantas från skisslås. Upp till 5 huvudkonton är tillåtna. string[]
läge Låsläge. "AllResourcesDoNotDelete"
"AllResourcesReadOnly"
"Ingen"

TilldelningEgenskaper

Namn Beskrivning Värde
blueprintId ID för den publicerade versionen av en skissdefinition. sträng
beskrivning Förklara den här resursen med flera rader. sträng

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

Begränsningar:
Max längd =
Lås Definierar hur resurser som distribueras av en skisstilldelning är låsta. AssignmentLockSettings
Parametrar Parametervärden för skisstilldelning. AssignmentPropertiesParameters (krävs)
resourceGroups Namn och platser för platshållare för resursgrupper. AssignmentPropertiesResourceGroups (krävs)
omfattning Skisstilldelningens målprenumerationsomfång (format: '/subscriptions/{subscriptionId}'). För tilldelningar på hanteringsgruppsnivå krävs egenskapen. sträng

AssignmentPropertiesParameters

Namn Beskrivning Värde

AssignmentPropertiesResourceGroups

Namn Beskrivning Värde

KeyVaultReference

Namn Beskrivning Värde
Id Azure-resurs-ID för Key Vault. sträng (krävs)

ManagedServiceIdentity

Namn Beskrivning Värde
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng
tenantId ID för Azure Active Directory. sträng
typ Typ av hanterad identitet. "Ingen"
"SystemAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Listan över användartilldelade hanterade identiteter som är associerade med resursen. Nyckeln är Azure-resurs-ID för den hanterade identiteten. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.Blueprint/blueprintAssignments

Namn Beskrivning Värde
apiVersion API-versionen "2018-11-01-preview"
identitet Hanterad identitet för den här skisstilldelningen. ManagedServiceIdentity (krävs)
plats Platsen för den här skisstilldelningen. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för skisstilldelningsobjekt. AssignmentProperties (krävs)
typ Resurstypen "Microsoft.Blueprint/blueprintAssignments"

ParameterValue

Namn Beskrivning Värde
hänvisning Parametervärde som referenstyp. SecretValueReference
värde Parametervärde. Alla giltiga JSON-värden tillåts, inklusive objekt, matriser, strängar, tal och booleska värden. någon

ResourceGroupValue

Namn Beskrivning Värde
plats Plats för resursgruppen. sträng
Namn Namnet på resursgruppen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1

SecretValueReference

Namn Beskrivning Värde
keyVault Anger referensen till ett visst Azure Key Vault. KeyVaultReference (krävs)
secretName Namnet på hemligheten. sträng (krävs)
secretVersion Den version av hemligheten som ska användas. Om den lämnas tom används den senaste versionen av hemligheten. sträng

UserAssignedIdentity

Namn Beskrivning Värde
clientId Klientapp-ID som är associerat med den här identiteten. sträng
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen blueprintAssignments 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/blueprintAssignments-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

AssignmentLockSettings

Namn Beskrivning Värde
excludedActions Lista över hanteringsåtgärder som undantas från skisslås. Upp till 200 åtgärder är tillåtna. Om låsläget är inställt på "AllResourcesReadOnly" läggs följande åtgärder automatiskt till i "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" och "Microsoft.Authorization/locks/delete". Om låsläget är inställt på "AllResourcesDoNotDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort. string[]
excludedPrincipals Lista över AAD-huvudnamn som undantas från skisslås. Upp till 5 huvudkonton är tillåtna. string[]
läge Låsläge. "AllResourcesDoNotDelete"
"AllResourcesReadOnly"
"Ingen"

TilldelningEgenskaper

Namn Beskrivning Värde
blueprintId ID för den publicerade versionen av en skissdefinition. sträng
beskrivning Förklara den här resursen med flera rader. sträng

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

Begränsningar:
Max längd =
Lås Definierar hur resurser som distribueras av en skisstilldelning är låsta. AssignmentLockSettings
Parametrar Parametervärden för skisstilldelning. AssignmentPropertiesParameters (krävs)
resourceGroups Namn och platser för platshållare för resursgrupper. AssignmentPropertiesResourceGroups (krävs)
omfattning Skisstilldelningens målprenumerationsomfång (format: '/subscriptions/{subscriptionId}'). För tilldelningar på hanteringsgruppsnivå krävs egenskapen. sträng

AssignmentPropertiesParameters

Namn Beskrivning Värde

AssignmentPropertiesResourceGroups

Namn Beskrivning Värde

KeyVaultReference

Namn Beskrivning Värde
Id Azure-resurs-ID för Key Vault. sträng (krävs)

ManagedServiceIdentity

Namn Beskrivning Värde
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng
tenantId ID för Azure Active Directory. sträng
typ Typ av hanterad identitet. "Ingen"
"SystemAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Listan över användartilldelade hanterade identiteter som är associerade med resursen. Nyckeln är Azure-resurs-ID för den hanterade identiteten. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

Microsoft.Blueprint/blueprintAssignments

Namn Beskrivning Värde
identitet Hanterad identitet för den här skisstilldelningen. ManagedServiceIdentity (krävs)
plats Platsen för den här skisstilldelningen. sträng (krävs)
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 Egenskaper för skisstilldelningsobjekt. AssignmentProperties (krävs)
typ Resurstypen "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"

ParameterValue

Namn Beskrivning Värde
hänvisning Parametervärde som referenstyp. SecretValueReference
värde Parametervärde. Alla giltiga JSON-värden tillåts, inklusive objekt, matriser, strängar, tal och booleska värden. någon

ResourceGroupValue

Namn Beskrivning Värde
plats Plats för resursgruppen. sträng
Namn Namnet på resursgruppen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1

SecretValueReference

Namn Beskrivning Värde
keyVault Anger referensen till ett visst Azure Key Vault. KeyVaultReference (krävs)
secretName Namnet på hemligheten. sträng (krävs)
secretVersion Den version av hemligheten som ska användas. Om den lämnas tom används den senaste versionen av hemligheten. sträng

UserAssignedIdentity

Namn Beskrivning Värde
clientId Klientapp-ID som är associerat med den här identiteten. sträng
principalId Huvud-ID för Azure Active Directory som är associerat med den här identiteten. sträng