Compartilhar via

Assignments - Create Or Update

Serviço:
Blueprints
Versão da API:
2018-11-01-preview

Crie ou atualize uma atribuição de blueprint.

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}?api-version=2018-11-01-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
assignmentName
 path True

string

Nome da atribuição de blueprint.
resourceScope
 path True

string

O escopo do recurso. Os escopos válidos são: grupo de gerenciamento (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), assinatura (formato: '/subscriptions/{subscriptionId}').
api-version
 query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
identity True

ManagedServiceIdentity

Identidade gerenciada para esta atribuição de blueprint.
location True

string

O local desta atribuição de blueprint.
properties.parameters True

<string,  ParameterValue>

Valores de parâmetro de atribuição de blueprint.
properties.resourceGroups True

<string,  ResourceGroupValue>

Nomes e locais de espaços reservados do grupo de recursos.
properties.blueprintId

string

ID da versão publicada de uma definição de blueprint.
properties.description

string

maxLength: 500

Várias linhas explicam esse recurso.
properties.displayName

string

maxLength: 256

Uma cadeia de caracteres de linha explica esse recurso.
properties.locks

AssignmentLockSettings

Define como os recursos implantados por uma atribuição de blueprint são bloqueados.
properties.scope

string

O escopo da assinatura de destino da atribuição de blueprint (formato: '/subscriptions/{subscriptionId}'). Para atribuições de nível de grupo de gerenciamento, a propriedade é necessária.

Respostas

Nome Tipo Description
201 Created

Assignment

Criado – atribuição de blueprint salva.
Other Status Codes

CloudError

Resposta de erro de blueprints.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Assignment with system-assigned managed identity at management group scope
Assignment with system-assigned managed identity at subscription scope
Assignment with user-assigned managed identity at management group scope
Assignment with user-assigned managed identity at subscription scope

Assignment with system-assigned managed identity at management group scope

Solicitação de exemplo

PUT https://management.azure.com/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with system-assigned managed identity at subscription scope

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at management group scope

Solicitação de exemplo

PUT https://management.azure.com/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at subscription scope

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Definições

Nome Description
Assignment

Representa uma atribuição de blueprint.
AssignmentLockMode

Modo de bloqueio.
AssignmentLockSettings

Define como os recursos implantados por uma atribuição de blueprint são bloqueados.
AssignmentProvisioningState

Estado da atribuição de blueprint.
AssignmentStatus

O status de uma atribuição de blueprint. Este campo é somente leitura.
CloudError
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse

Resposta de erro
keyVaultReference

Especifica o link para um Key Vault.
ManagedServiceIdentity

Objeto genérico de identidade gerenciada.
ManagedServiceIdentityType

Tipo da identidade gerenciada.
ParameterValue

Valor do parâmetro especificado. Pode ser 'value' ou 'reference', mas não ambos.
ResourceGroupValue

Representa um grupo de recursos do Azure.
SecretValueReference

Referência a um segredo do Key Vault.
UserAssignedIdentity

Identidade gerenciada atribuída pelo usuário.

Assignment

Objeto

Representa uma atribuição de blueprint.

Nome Tipo Description
id

string

ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
identity

ManagedServiceIdentity

Identidade gerenciada para esta atribuição de blueprint.
location

string

O local desta atribuição de blueprint.
name

string

Nome desse recurso.
properties.blueprintId

string

ID da versão publicada de uma definição de blueprint.
properties.description

string

maxLength: 500

Várias linhas explicam esse recurso.
properties.displayName

string

maxLength: 256

Uma cadeia de caracteres de linha explica esse recurso.
properties.locks

AssignmentLockSettings

Define como os recursos implantados por uma atribuição de blueprint são bloqueados.
properties.parameters

<string,  ParameterValue>

Valores de parâmetro de atribuição de blueprint.
properties.provisioningState

AssignmentProvisioningState

Estado da atribuição de blueprint.
properties.resourceGroups

<string,  ResourceGroupValue>

Nomes e locais de espaços reservados do grupo de recursos.
properties.scope

string

O escopo da assinatura de destino da atribuição de blueprint (formato: '/subscriptions/{subscriptionId}'). Para atribuições de nível de grupo de gerenciamento, a propriedade é necessária.
properties.status

AssignmentStatus

Status da atribuição de blueprint. Este campo é somente leitura.
type

string

Tipo desse recurso.

AssignmentLockMode

Enumeração

Modo de bloqueio.

Valor Description
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Objeto

Define como os recursos implantados por uma atribuição de blueprint são bloqueados.

Nome Tipo Description
excludedActions

string[]

Lista de operações de gerenciamento excluídas dos bloqueios de blueprint. Até 200 ações são permitidas. Se o modo de bloqueio estiver definido como 'AllResourcesReadOnly', as seguintes ações serão acrescentadas automaticamente a 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' e 'Microsoft.Authorization/locks/delete'. Se o modo de bloqueio estiver definido como 'AllResourcesDoNotDelete', as seguintes ações serão acrescentadas automaticamente a 'excludedActions': 'Microsoft.Authorization/locks/delete'. As ações duplicadas serão removidas.
excludedPrincipals

string[]

Lista de entidades de segurança do AAD excluídas dos bloqueios de blueprint. Até 5 entidades de segurança são permitidas.
mode

AssignmentLockMode

Modo de bloqueio.

AssignmentProvisioningState

Enumeração

Estado da atribuição de blueprint.

Valor Description
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Objeto

O status de uma atribuição de blueprint. Este campo é somente leitura.

Nome Tipo Description
lastModified

string (date-time)

Hora da última modificação dessa definição de blueprint.
managedResources

string[]

Lista de recursos que foram criados pela atribuição de blueprint.
timeCreated

string (date-time)

Hora de criação dessa definição de blueprint.

CloudError

Objeto
Nome Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorResponse[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

keyVaultReference

Objeto

Especifica o link para um Key Vault.

Nome Tipo Description
id

string

ID de recurso do Azure do Key Vault.

ManagedServiceIdentity

Objeto

Objeto genérico de identidade gerenciada.

Nome Tipo Description
principalId

string

ID da entidade de segurança do Azure Active Directory associada a essa Identidade.
tenantId

string

ID do Azure Active Directory.
type

ManagedServiceIdentityType

Tipo da identidade gerenciada.
userAssignedIdentities

<string,  UserAssignedIdentity>

A lista de identidades gerenciadas atribuídas pelo usuário associadas ao recurso. A chave é a ID de recurso do Azure da identidade gerenciada.

ManagedServiceIdentityType

Enumeração

Tipo da identidade gerenciada.

Valor Description
None
SystemAssigned
UserAssigned

ParameterValue

Objeto

Valor do parâmetro especificado. Pode ser 'value' ou 'reference', mas não ambos.

Nome Tipo Description
reference

SecretValueReference

Valor do parâmetro como tipo de referência.
value

object

Valor de parâmetro. Qualquer valor JSON válido é permitido, incluindo objetos, matrizes, cadeias de caracteres, números e boolianos.

ResourceGroupValue

Objeto

Representa um grupo de recursos do Azure.

Nome Tipo Description
location

string

Local do grupo de recursos.
name

string

minLength: 1
maxLength: 90

Nome do grupo de recursos.

SecretValueReference

Objeto

Referência a um segredo do Key Vault.

Nome Tipo Description
keyVault

keyVaultReference

Especifica a referência a um determinado Azure Key Vault.
secretName

string

Nome do segredo.
secretVersion

string

A versão do segredo a ser usado. Se deixado em branco, a versão mais recente do segredo será usada.

UserAssignedIdentity

Objeto

Identidade gerenciada atribuída pelo usuário.

Nome Tipo Description
clientId

string

ID do aplicativo cliente associada a essa identidade.
principalId

string

ID da entidade de segurança do Azure Active Directory associada a essa Identidade.