Assignments - Create Or Update

Cree o actualice una asignación de plano técnico.

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

Parámetros de identificador URI

Name In Required Type Description
assignmentName
path True
  • string

Nombre de la asignación del plano técnico.

resourceScope
path True
  • string

Ámbito del recurso. Los ámbitos válidos son: grupo de administración (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}').

api-version
query True
  • string

Versión de la API de cliente.

Cuerpo de la solicitud

Name Required Type Description
identity True

Identidad administrada para esta asignación de plano técnico.

location True
  • string

Ubicación de esta asignación de plano técnico.

properties.parameters True

Valores de parámetros de asignación de planos técnicos.

properties.resourceGroups True

Nombres y ubicaciones de marcadores de posición del grupo de recursos.

properties.blueprintId
  • string

Identificador de la versión publicada de una definición de plano técnico.

properties.description
  • string

Explicar este recurso en varias líneas.

properties.displayName
  • string

La cadena de un liner explica este recurso.

properties.locks

Define cómo se bloquean los recursos implementados por una asignación de plano técnico.

properties.scope
  • string

Ámbito de la suscripción de destino de la asignación de plano técnico (formato: "/subscriptions/{subscriptionId}"). Para las asignaciones de nivel de grupo de administración, se requiere la propiedad .

Respuestas

Name Type Description
201 Created

Creado: asignación de plano técnico guardada.

Other Status Codes

Respuesta de error de planos técnicos.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definiciones

Assignment

Representa una asignación de plano técnico.

AssignmentLockMode

Modo de bloqueo.

AssignmentLockSettings

Define cómo se bloquean los recursos implementados por una asignación de plano técnico.

AssignmentProvisioningState

Estado de la asignación del plano técnico.

AssignmentStatus

Estado de una asignación de plano técnico. Este campo es de solo lectura.

CloudError
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorResponse

Respuesta de error

keyVaultReference

Especifica el vínculo a un Key Vault.

ManagedServiceIdentity

Objeto genérico de identidad administrada.

ManagedServiceIdentityType

Tipo de la identidad administrada.

ParameterValue

Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.

ResourceGroupValue

Representa un grupo de recursos de Azure.

SecretValueReference

Referencia a un secreto de Key Vault.

UserAssignedIdentity

Identidad administrada asignada por el usuario.

Assignment

Representa una asignación de plano técnico.

Name Type Description
id
  • string

Identificador de cadena que se usa para buscar cualquier recurso en Azure.

identity

Identidad administrada para esta asignación de plano técnico.

location
  • string

Ubicación de esta asignación de plano técnico.

name
  • string

Nombre de este recurso.

properties.blueprintId
  • string

Identificador de la versión publicada de una definición de plano técnico.

properties.description
  • string

Explicar este recurso en varias líneas.

properties.displayName
  • string

La cadena de un liner explica este recurso.

properties.locks

Define cómo se bloquean los recursos implementados por una asignación de plano técnico.

properties.parameters

Valores de parámetros de asignación de planos técnicos.

properties.provisioningState

Estado de la asignación del plano técnico.

properties.resourceGroups

Nombres y ubicaciones de marcadores de posición del grupo de recursos.

properties.scope
  • string

Ámbito de la suscripción de destino de la asignación de plano técnico (formato: "/subscriptions/{subscriptionId}"). Para las asignaciones de nivel de grupo de administración, se requiere la propiedad .

properties.status

Estado de la asignación de plano técnico. Este campo es de solo lectura.

type
  • string

Tipo de este recurso.

AssignmentLockMode

Modo de bloqueo.

Name Type Description
AllResourcesDoNotDelete
  • string
AllResourcesReadOnly
  • string
None
  • string

AssignmentLockSettings

Define cómo se bloquean los recursos implementados por una asignación de plano técnico.

Name Type Description
excludedActions
  • string[]

Lista de operaciones de administración que se excluyen de los bloqueos de plano técnico. Se permiten hasta 200 acciones. Si el modo de bloqueo se establece en "AllResourcesReadOnly", las siguientes acciones se anexan automáticamente a "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" y "Microsoft.Authorization/locks/delete". Si el modo de bloqueo se establece en "AllResourcesDoNotDelete", las siguientes acciones se anexan automáticamente a "excludedActions": "Microsoft.Authorization/locks/delete". Se quitarán las acciones duplicadas.

excludedPrincipals
  • string[]

Lista de entidades de seguridad de AAD excluidas de los bloqueos de plano técnico. Se permiten hasta 5 entidades de seguridad.

mode

Modo de bloqueo.

AssignmentProvisioningState

Estado de la asignación del plano técnico.

Name Type Description
canceled
  • string
cancelling
  • string
creating
  • string
deleting
  • string
deploying
  • string
failed
  • string
locking
  • string
succeeded
  • string
validating
  • string
waiting
  • string

AssignmentStatus

Estado de una asignación de plano técnico. Este campo es de solo lectura.

Name Type Description
lastModified
  • string

Hora de última modificación de esta definición de plano técnico.

managedResources
  • string[]

Lista de recursos creados por la asignación del plano técnico.

timeCreated
  • string

Hora de creación de esta definición de plano técnico.

CloudError

Name Type Description
error

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorResponse

Respuesta de error

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

keyVaultReference

Especifica el vínculo a un Key Vault.

Name Type Description
id
  • string

Identificador de recurso de Azure del Key Vault.

ManagedServiceIdentity

Objeto genérico de identidad administrada.

Name Type Description
principalId
  • string

Azure Active Directory identificador de entidad de seguridad asociado a esta identidad.

tenantId
  • string

Identificador del Azure Active Directory.

type

Tipo de la identidad administrada.

userAssignedIdentities

Lista de identidades administradas asignadas por el usuario asociadas al recurso. La clave es el identificador de recurso de Azure de la identidad administrada.

ManagedServiceIdentityType

Tipo de la identidad administrada.

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

ParameterValue

Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.

Name Type Description
reference

Valor de parámetro como tipo de referencia.

value
  • object

Valor del parámetro. Se permite cualquier valor JSON válido, incluidos objetos, matrices, cadenas, números y booleanos.

ResourceGroupValue

Representa un grupo de recursos de Azure.

Name Type Description
location
  • string

Ubicación del grupo de recursos.

name
  • string

Nombre del grupo de recursos.

SecretValueReference

Referencia a un secreto de Key Vault.

Name Type Description
keyVault

Especifica la referencia a una Key Vault de Azure determinada.

secretName
  • string

Nombre del secreto.

secretVersion
  • string

Versión del secreto que se va a usar. Si se deja en blanco, se usa la versión más reciente del secreto.

UserAssignedIdentity

Identidad administrada asignada por el usuario.

Name Type Description
clientId
  • string

Id. de aplicación cliente asociado a esta identidad.

principalId
  • string

Azure Active Directory identificador de entidad de seguridad asociado a esta identidad.