Partilhar 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 do URI

Name Em Necessário Tipo Description
assignmentName
 path True

string

Nome da atribuição do 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 do Pedido

Name Necessá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 dos parâmetros de atribuição do Blueprint.
properties.resourceGroups True

<string,  ResourceGroupValue>

Nomes e locais de espaços reservados para grupos de recursos.
properties.blueprintId

string

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

string

maxLength: 500

Multi-linha explicar este recurso.
properties.displayName

string

maxLength: 256

Uma cadeia de caracteres de linha única explica este recurso.
properties.locks

AssignmentLockSettings

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

string

O escopo de 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

Name Tipo Description
201 Created

Assignment

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

CloudError

Blueprints resposta de erro.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Name 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 do modelo.
AssignmentStatus

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

O erro de gerenciamento de recursos informações adicionais.
ErrorResponse

Resposta de erro
keyVaultReference

Especifica o link para um Cofre de Chaves.
ManagedServiceIdentity

Objeto genérico de identidade gerenciada.
ManagedServiceIdentityType

Tipo de identidade gerenciada.
ParameterValue

Valor para o parâmetro especificado. Pode ser "valor" ou "referência", mas não ambos.
ResourceGroupValue

Representa um grupo de recursos do Azure.
SecretValueReference

Referência a um segredo do Cofre da Chave.
UserAssignedIdentity

Identidade gerenciada atribuída pelo usuário.

Assignment

Object

Representa uma atribuição de blueprint.

Name 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 deste recurso.
properties.blueprintId

string

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

string

maxLength: 500

Multi-linha explicar este recurso.
properties.displayName

string

maxLength: 256

Uma cadeia de caracteres de linha única explica este recurso.
properties.locks

AssignmentLockSettings

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

<string,  ParameterValue>

Valores dos parâmetros de atribuição do Blueprint.
properties.provisioningState

AssignmentProvisioningState

Estado da atribuição do modelo.
properties.resourceGroups

<string,  ResourceGroupValue>

Nomes e locais de espaços reservados para grupos de recursos.
properties.scope

string

O escopo de 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 do blueprint. Este campo é somente leitura.
type

string

Tipo deste recurso.

AssignmentLockMode

Enumeração

Modo de bloqueio.

Valor Description
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Object

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

Name Tipo Description
excludedActions

string[]

Lista de operações de gerenciamento excluídas dos bloqueios de blueprint. São permitidas até 200 ações. Se o modo de bloqueio estiver definido como 'AllResourcesReadOnly', as seguintes ações serão automaticamente acrescentadas 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 automaticamente acrescentadas a 'excludedActions': 'Microsoft.Authorization/locks/delete'. As ações duplicadas serão removidas.
excludedPrincipals

string[]

Lista de entidades de AAD excluídas dos bloqueios de blueprint. São permitidos até 5 princípios.
mode

AssignmentLockMode

Modo de bloqueio.

AssignmentProvisioningState

Enumeração

Estado da atribuição do modelo.

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

AssignmentStatus

Object

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

Name Tipo Description
lastModified

string (date-time)

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

string[]

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

string (date-time)

Tempo de criação desta definição de blueprint.

CloudError

Object
Name Tipo Description
error

ErrorResponse

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Especifica o link para um Cofre de Chaves.

Name Tipo Description
id

string

ID de recurso do Azure do Cofre da Chave.

ManagedServiceIdentity

Object

Objeto genérico de identidade gerenciada.

Name Tipo Description
principalId

string

ID principal do Azure Ative Directory associada a esta Identidade.
tenantId

string

ID do Azure Ative Directory.
type

ManagedServiceIdentityType

Tipo de identidade gerenciada.
userAssignedIdentities

<string,  UserAssignedIdentity>

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

ManagedServiceIdentityType

Enumeração

Tipo de identidade gerenciada.

Valor Description
None
SystemAssigned
UserAssigned

ParameterValue

Object

Valor para o parâmetro especificado. Pode ser "valor" ou "referência", mas não ambos.

Name Tipo Description
reference

SecretValueReference

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

object

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

ResourceGroupValue

Object

Representa um grupo de recursos do Azure.

Name Tipo Description
location

string

Localização do grupo de recursos.
name

string

minLength: 1
maxLength: 90

Nome do grupo de recursos.

SecretValueReference

Object

Referência a um segredo do Cofre da Chave.

Name Tipo Description
keyVault

keyVaultReference

Especifica a referência a um determinado Cofre de Chaves do Azure.
secretName

string

Nome do segredo.
secretVersion

string

A versão do segredo a usar. Se deixado em branco, a versão mais recente do segredo é usada.

UserAssignedIdentity

Object

Identidade gerenciada atribuída pelo usuário.

Name Tipo Description
clientId

string

ID do aplicativo cliente associado a essa identidade.
principalId

string

ID principal do Azure Ative Directory associada a esta Identidade.