Assignments - Create Or Update

Hizmet:

Blueprints

API Sürümü:

2018-11-01-preview

Şema ataması oluşturma veya güncelleştirme.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
assignmentName	path	True	string	Şema atamasının adı.
resourceScope	path	True	string	Kaynağın kapsamı. Geçerli kapsamlar şunlardır: yönetim grubu (biçim: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), abonelik (biçim: '/subscriptions/{subscriptionId}').
api-version	query	True	string	İstemci API Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
identity	True	ManagedServiceIdentity	Bu şema ataması için yönetilen kimlik.
location	True	string	Bu şema atamasının konumu.
properties.parameters	True	<string,  ParameterValue>	Şema ataması parametre değerleri.
properties.resourceGroups	True	<string,  ResourceGroupValue>	Kaynak grubu yer tutucularının adları ve konumları.
properties.blueprintId		string	Şema tanımının yayımlanmış sürümünün kimliği.
properties.description		string maxLength: 500	Bu kaynağı çok satırlı olarak açıklayın.
properties.displayName		string maxLength: 256	Tek satırlık dize bu kaynağı açıklar.
properties.locks		AssignmentLockSettings	Şema ataması tarafından dağıtılan kaynakların nasıl kilitlendiğini tanımlar.
properties.scope		string	Şema atamasının hedef abonelik kapsamı (biçim: '/subscriptions/{subscriptionId}'). Yönetim grubu düzeyi atamaları için özelliği gereklidir.

Yanıtlar

Name	Tür	Description
201 Created	Assignment	Oluşturuldu -- şema ataması kaydedildi.
Other Status Codes	CloudError	Şemalar hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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

Tanımlar

Name	Description
Assignment	Şema atamalarını temsil eder.
AssignmentLockMode	Kilit modu.
AssignmentLockSettings	Şema ataması tarafından dağıtılan kaynakların nasıl kilitlendiğini tanımlar.
AssignmentProvisioningState	Şema atamasının durumu.
AssignmentStatus	Şema atamasının durumu. Bu alan salt okunur.
CloudError
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Hata Yanıtı
keyVaultReference	Key Vault bağlantısını belirtir.
ManagedServiceIdentity	Yönetilen kimlik genel nesnesi.
ManagedServiceIdentityType	Yönetilen kimliğin türü.
ParameterValue	Belirtilen parametrenin değeri. 'değer' veya 'başvuru' olabilir, ancak ikisi birden olamaz.
ResourceGroupValue	Bir Azure kaynak grubunu temsil eder.
SecretValueReference	Key Vault gizli dizisine başvuru.
UserAssignedIdentity	Kullanıcı tarafından atanan yönetilen kimlik.

Assignment

Object

Şema atamalarını temsil eder.

Name	Tür	Description
id	string	Azure'da herhangi bir kaynağı bulmak için kullanılan dize kimliği.
identity	ManagedServiceIdentity	Bu şema ataması için yönetilen kimlik.
location	string	Bu şema atamasının konumu.
name	string	Bu kaynağın adı.
properties.blueprintId	string	Şema tanımının yayımlanmış sürümünün kimliği.
properties.description	string maxLength: 500	Bu kaynağı çok satırlı olarak açıklayın.
properties.displayName	string maxLength: 256	Tek satırlık dize bu kaynağı açıklar.
properties.locks	AssignmentLockSettings	Şema ataması tarafından dağıtılan kaynakların nasıl kilitlendiğini tanımlar.
properties.parameters	<string,  ParameterValue>	Şema ataması parametre değerleri.
properties.provisioningState	AssignmentProvisioningState	Şema atamasının durumu.
properties.resourceGroups	<string,  ResourceGroupValue>	Kaynak grubu yer tutucularının adları ve konumları.
properties.scope	string	Şema atamasının hedef abonelik kapsamı (biçim: '/subscriptions/{subscriptionId}'). Yönetim grubu düzeyi atamaları için özelliği gereklidir.
properties.status	AssignmentStatus	Şema atamasının durumu. Bu alan salt okunur.
type	string	Bu kaynağın türü.

AssignmentLockMode

Listeleme

Kilit modu.

Değer	Description
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Object

Şema ataması tarafından dağıtılan kaynakların nasıl kilitlendiğini tanımlar.

Name	Tür	Description
excludedActions	string[]	Şema kilitlerinin dışında tutulan yönetim işlemlerinin listesi. En fazla 200 eyleme izin verilir. Kilit modu 'AllResourcesReadOnly' olarak ayarlanırsa, şu eylemler otomatik olarak 'excludedActions'a eklenir: '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' ve 'Microsoft.Authorization/locks/delete'. Kilit modu 'AllResourcesDoNotDelete' olarak ayarlanırsa, şu eylemler 'excludedActions' öğesine otomatik olarak eklenir: 'Microsoft.Authorization/locks/delete'. Yinelenen eylemler kaldırılır.
excludedPrincipals	string[]	Şema kilitlerinin dışında tutulan AAD sorumlularının listesi. En fazla 5 sorumluya izin verilir.
mode	AssignmentLockMode	Kilit modu.

AssignmentProvisioningState

Listeleme

Şema atamasının durumu.

Değer	Description
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Object

Şema atamasının durumu. Bu alan salt okunur.

Name	Tür	Description
lastModified	string (date-time)	Bu şema tanımının son değiştirme zamanı.
managedResources	string[]	Şema ataması tarafından oluşturulan kaynakların listesi.
timeCreated	string (date-time)	Bu şema tanımının oluşturma zamanı.

CloudError

Object

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorResponse

Object

Hata Yanıtı

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

keyVaultReference

Object

Key Vault bağlantısını belirtir.

Name	Tür	Description
id	string	Key Vault'un Azure kaynak kimliği.

ManagedServiceIdentity

Object

Yönetilen kimlik genel nesnesi.

Name	Tür	Description
principalId	string	Bu Kimlikle ilişkili Azure Active Directory asıl kimliği.
tenantId	string	Azure Active Directory kimliği.
type	ManagedServiceIdentityType	Yönetilen kimliğin türü.
userAssignedIdentities	<string,  UserAssignedIdentity>	Kaynakla ilişkili kullanıcı tarafından atanan yönetilen kimliklerin listesi. Anahtar, yönetilen kimliğin Azure kaynak kimliğidir.

ManagedServiceIdentityType

Listeleme

Yönetilen kimliğin türü.

Değer	Description
None
SystemAssigned
UserAssigned

ParameterValue

Object

Belirtilen parametrenin değeri. 'değer' veya 'başvuru' olabilir, ancak ikisi birden olamaz.

Name	Tür	Description
reference	SecretValueReference	Başvuru türü olarak parametre değeri.
value	object	Parametre değeri. Nesneler, diziler, dizeler, sayılar ve boole değerleri dahil olmak üzere geçerli JSON değerlerine izin verilir.

ResourceGroupValue

Object

Bir Azure kaynak grubunu temsil eder.

Name	Tür	Description
location	string	Kaynak grubunun konumu.
name	string minLength: 1 maxLength: 90	Kaynak grubunun adı.

SecretValueReference

Object

Key Vault gizli dizisine başvuru.

Name	Tür	Description
keyVault	keyVaultReference	Belirli bir Azure Key Vault'a başvuruyu belirtir.
secretName	string	Gizli dizinin adı.
secretVersion	string	Kullanılacak gizli dizi sürümü. Boş bırakılırsa, gizli dizinin en son sürümü kullanılır.

UserAssignedIdentity

Object

Kullanıcı tarafından atanan yönetilen kimlik.

Name	Tür	Description
clientId	string	Bu kimlikle ilişkili İstemci Uygulama Kimliği.
principalId	string	Bu Kimlikle ilişkili Azure Active Directory asıl kimliği.