Megosztás a következőn keresztül:


Assignments - Create Or Update

Terv-hozzárendelés létrehozása vagy frissítése.

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

URI-paraméterek

Name In Kötelező Típus Description
assignmentName
path True

string

A terv-hozzárendelés neve.

resourceScope
path True

string

Az erőforrás hatóköre. Érvényes hatókörök: felügyeleti csoport (formátum: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), előfizetés (formátum: "/subscriptions/{subscriptionId}").

api-version
query True

string

Ügyfél API-verziója.

Kérelem törzse

Name Kötelező Típus Description
identity True

ManagedServiceIdentity

A terv-hozzárendelés felügyelt identitása.

location True

string

A terv-hozzárendelés helye.

properties.parameters True

<string,  ParameterValue>

Terv-hozzárendelési paraméterértékek.

properties.resourceGroups True

<string,  ResourceGroupValue>

Az erőforráscsoport helyőrzőinek nevei és helyei.

properties.blueprintId

string

A tervdefiníció közzétett verziójának azonosítója.

properties.description

string

maxLength: 500

Többsoros magyarázat az erőforrásra.

properties.displayName

string

maxLength: 256

Egysoros sztring ismerteti ezt az erőforrást.

properties.locks

AssignmentLockSettings

Meghatározza, hogy a terv-hozzárendelés által üzembe helyezett erőforrások hogyan legyenek zárolva.

properties.scope

string

A terv-hozzárendelés célelőfizetési hatóköre (formátum: '/subscriptions/{subscriptionId}'). A felügyeleti csoportszintű hozzárendelésekhez a tulajdonságra van szükség.

Válaszok

Name Típus Description
201 Created

Assignment

Létrehozva – mentett terv-hozzárendelés.

Other Status Codes

CloudError

Tervekkel kapcsolatos hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
Assignment

Tervhozzárendelést jelöl.

AssignmentLockMode

Zárolási mód.

AssignmentLockSettings

Meghatározza, hogy a terv-hozzárendelés által üzembe helyezett erőforrások hogyan legyenek zárolva.

AssignmentProvisioningState

A terv-hozzárendelés állapota.

AssignmentStatus

A terv-hozzárendelés állapota. Ez a mező olvasható.

CloudError
ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorResponse

Hibaválasz

keyVaultReference

A Key Vaultra mutató hivatkozást adja meg.

ManagedServiceIdentity

Felügyelt identitás általános objektuma.

ManagedServiceIdentityType

A felügyelt identitás típusa.

ParameterValue

A megadott paraméter értéke. Lehet "érték" vagy "hivatkozás", de mindkettő nem.

ResourceGroupValue

Egy Azure-erőforráscsoportot jelöl.

SecretValueReference

Hivatkozás Key Vault-titkos kódra.

UserAssignedIdentity

Felhasználó által hozzárendelt felügyelt identitás.

Assignment

Tervhozzárendelést jelöl.

Name Típus Description
id

string

Az Azure-ban található erőforrások megkereséséhez használt karakterlánc-azonosító.

identity

ManagedServiceIdentity

A terv-hozzárendelés felügyelt identitása.

location

string

A terv-hozzárendelés helye.

name

string

Az erőforrás neve.

properties.blueprintId

string

A tervdefiníció közzétett verziójának azonosítója.

properties.description

string

maxLength: 500

Többsoros magyarázat az erőforrásra.

properties.displayName

string

maxLength: 256

Egysoros sztring ismerteti ezt az erőforrást.

properties.locks

AssignmentLockSettings

Meghatározza, hogy a terv-hozzárendelés által üzembe helyezett erőforrások hogyan legyenek zárolva.

properties.parameters

<string,  ParameterValue>

Terv-hozzárendelési paraméterértékek.

properties.provisioningState

AssignmentProvisioningState

A terv-hozzárendelés állapota.

properties.resourceGroups

<string,  ResourceGroupValue>

Az erőforráscsoport helyőrzőinek nevei és helyei.

properties.scope

string

A terv-hozzárendelés célelőfizetési hatóköre (formátum: '/subscriptions/{subscriptionId}'). A felügyeleti csoportszintű hozzárendelésekhez a tulajdonságra van szükség.

properties.status

AssignmentStatus

A terv hozzárendelésének állapota. Ez a mező olvasható.

type

string

Az erőforrás típusa.

AssignmentLockMode

Zárolási mód.

Érték Description
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

Meghatározza, hogy a terv-hozzárendelés által üzembe helyezett erőforrások hogyan legyenek zárolva.

Name Típus Description
excludedActions

string[]

A tervzárakból kizárt felügyeleti műveletek listája. Legfeljebb 200 művelet engedélyezett. Ha a zárolási mód "AllResourcesReadOnly" értékre van állítva, akkor a rendszer automatikusan hozzáfűzi a következő műveleteket a "excludedActions" elemhez: "*/read", "Microsoft.Network/virtualNetworks/alhálózatok/join/action" és "Microsoft.Authorization/locks/delete". Ha a zárolási mód "AllResourcesDoNotDelete" értékre van állítva, akkor a rendszer automatikusan hozzáfűzi a következő műveleteket a "excludedActions" elemhez: "Microsoft.Authorization/locks/delete". Az ismétlődő műveletek el lesznek távolítva.

excludedPrincipals

string[]

A tervzárakból kizárt AAD-tagok listája. Legfeljebb 5 tag engedélyezett.

mode

AssignmentLockMode

Zárolási mód.

AssignmentProvisioningState

A terv-hozzárendelés állapota.

Érték Description
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

A terv-hozzárendelés állapota. Ez a mező olvasható.

Name Típus Description
lastModified

string (date-time)

A tervdefiníció utolsó módosítási időpontja.

managedResources

string[]

A terv-hozzárendelés által létrehozott erőforrások listája.

timeCreated

string (date-time)

A tervdefiníció létrehozási ideje.

CloudError

Name Típus Description
error

ErrorResponse

Hibaválasz
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további információtípus.

ErrorResponse

Hibaválasz

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorResponse[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hibacél.

keyVaultReference

A Key Vaultra mutató hivatkozást adja meg.

Name Típus Description
id

string

A Key Vault Azure-erőforrás-azonosítója.

ManagedServiceIdentity

Felügyelt identitás általános objektuma.

Name Típus Description
principalId

string

Az identitáshoz társított Azure Active Directory-egyszerű azonosító.

tenantId

string

Az Azure Active Directory azonosítója.

type

ManagedServiceIdentityType

A felügyelt identitás típusa.

userAssignedIdentities

<string,  UserAssignedIdentity>

Az erőforráshoz társított, felhasználó által hozzárendelt felügyelt identitások listája. A kulcs a felügyelt identitás Azure-erőforrás-azonosítója.

ManagedServiceIdentityType

A felügyelt identitás típusa.

Érték Description
None
SystemAssigned
UserAssigned

ParameterValue

A megadott paraméter értéke. Lehet "érték" vagy "hivatkozás", de mindkettő nem.

Name Típus Description
reference

SecretValueReference

Paraméterérték referenciatípusként.

value

object

Paraméterérték. Bármely érvényes JSON-érték megengedett, beleértve az objektumokat, tömböket, sztringeket, számokat és logikai értékeket.

ResourceGroupValue

Egy Azure-erőforráscsoportot jelöl.

Name Típus Description
location

string

Az erőforráscsoport helye.

name

string

minLength: 1
maxLength: 90

Az erőforráscsoport neve.

SecretValueReference

Hivatkozás Key Vault-titkos kódra.

Name Típus Description
keyVault

keyVaultReference

Egy adott Azure Key Vaultra mutató hivatkozást ad meg.

secretName

string

A titkos kód neve.

secretVersion

string

A használni kívánt titkos kód verziója. Ha üresen hagyja, a titkos kód legújabb verzióját használja a rendszer.

UserAssignedIdentity

Felhasználó által hozzárendelt felügyelt identitás.

Name Típus Description
clientId

string

Az identitáshoz társított ügyfélalkalmazás-azonosító.

principalId

string

Az identitáshoz társított Azure Active Directory-egyszerű azonosító.