Поделиться через


Assignments - Create Or Update

Создание или обновление назначения схемы.

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

Параметры URI

Имя В Обязательно Тип Описание
assignmentName
path True

string

Имя назначения схемы.

resourceScope
path True

string

Область ресурса. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат "/subscriptions/{subscriptionId}").

api-version
query True

string

Версия КЛИЕНТСКОго API.

Текст запроса

Имя Обязательно Тип Описание
identity True

ManagedServiceIdentity

Управляемое удостоверение для этого назначения схемы.

location True

string

Расположение этого назначения схемы.

properties.parameters True

<string,  ParameterValue>

Значения параметров назначения схемы.

properties.resourceGroups True

<string,  ResourceGroupValue>

Имена и расположения заполнителей групп ресурсов.

properties.blueprintId

string

Идентификатор опубликованной версии определения схемы.

properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.

properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.

properties.locks

AssignmentLockSettings

Определяет, как ресурсы, развернутые назначением схемы, блокируются.

properties.scope

string

Целевая область подписки назначения схемы (формат :/subscriptions/{subscriptionId}). Для назначений на уровне группы управления требуется свойство.

Ответы

Имя Тип Описание
201 Created

Assignment

Создано — сохраненное назначение схемы.

Other Status Codes

CloudError

Ответ на ошибку схемы.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
Assignment

Представляет назначение схемы.

AssignmentLockMode

Режим блокировки.

AssignmentLockSettings

Определяет, как ресурсы, развернутые назначением схемы, блокируются.

AssignmentProvisioningState

Состояние назначения схемы.

AssignmentStatus

Состояние назначения схемы. Это поле доступно для чтения.

CloudError
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Ответ на ошибку

keyVaultReference

Указывает ссылку на Key Vault.

ManagedServiceIdentity

Универсальный объект управляемого удостоверения.

ManagedServiceIdentityType

Тип управляемого удостоверения.

ParameterValue

Значение указанного параметра. Может быть либо значением, либо ссылкой, но не обоими.

ResourceGroupValue

Представляет группу ресурсов Azure.

SecretValueReference

Ссылка на секрет Key Vault.

UserAssignedIdentity

Назначаемое пользователем управляемое удостоверение.

Assignment

Представляет назначение схемы.

Имя Тип Описание
id

string

Идентификатор строки, используемый для поиска любого ресурса в Azure.

identity

ManagedServiceIdentity

Управляемое удостоверение для этого назначения схемы.

location

string

Расположение этого назначения схемы.

name

string

Имя этого ресурса.

properties.blueprintId

string

Идентификатор опубликованной версии определения схемы.

properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.

properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.

properties.locks

AssignmentLockSettings

Определяет, как ресурсы, развернутые назначением схемы, блокируются.

properties.parameters

<string,  ParameterValue>

Значения параметров назначения схемы.

properties.provisioningState

AssignmentProvisioningState

Состояние назначения схемы.

properties.resourceGroups

<string,  ResourceGroupValue>

Имена и расположения заполнителей групп ресурсов.

properties.scope

string

Целевая область подписки назначения схемы (формат :/subscriptions/{subscriptionId}). Для назначений на уровне группы управления требуется свойство.

properties.status

AssignmentStatus

Состояние назначения схемы. Это поле доступно для чтения.

type

string

Тип этого ресурса.

AssignmentLockMode

Режим блокировки.

Значение Описание
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

Определяет, как ресурсы, развернутые назначением схемы, блокируются.

Имя Тип Описание
excludedActions

string[]

Список операций управления, исключенных из блокировок схемы. Разрешено до 200 действий. Если для режима блокировки задано значение AllResourcesReadOnly, то следующие действия автоматически добавляются в "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" и "Microsoft.Authorization/locks/delete". Если для режима блокировки задано значение AllResourcesDoNotDelete, то следующие действия автоматически добавляются в "excludedActions": "Microsoft.Authorization/locks/delete". Повторяющиеся действия будут удалены.

excludedPrincipals

string[]

Список субъектов AAD, исключенных из блокировок схемы. Разрешено до 5 субъектов.

mode

AssignmentLockMode

Режим блокировки.

AssignmentProvisioningState

Состояние назначения схемы.

Значение Описание
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

Состояние назначения схемы. Это поле доступно для чтения.

Имя Тип Описание
lastModified

string (date-time)

Время последнего изменения определения схемы.

managedResources

string[]

Список ресурсов, созданных назначением схемы.

timeCreated

string (date-time)

Время создания определения схемы.

CloudError

Имя Тип Описание
error

ErrorResponse

Ответ на ошибку
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку OData.)

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorResponse[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

keyVaultReference

Указывает ссылку на Key Vault.

Имя Тип Описание
id

string

Идентификатор ресурса Azure в Key Vault.

ManagedServiceIdentity

Универсальный объект управляемого удостоверения.

Имя Тип Описание
principalId

string

Идентификатор субъекта Azure Active Directory, связанный с этим удостоверением.

tenantId

string

Идентификатор Azure Active Directory.

type

ManagedServiceIdentityType

Тип управляемого удостоверения.

userAssignedIdentities

<string,  UserAssignedIdentity>

Список назначаемых пользователем управляемых удостоверений, связанных с ресурсом. Ключом является идентификатор ресурса Azure управляемого удостоверения.

ManagedServiceIdentityType

Тип управляемого удостоверения.

Значение Описание
None
SystemAssigned
UserAssigned

ParameterValue

Значение указанного параметра. Может быть либо значением, либо ссылкой, но не обоими.

Имя Тип Описание
reference

SecretValueReference

Значение параметра в качестве ссылочного типа.

value

object

Значение параметра. Любое допустимое значение JSON допускается, включая объекты, массивы, строки, числа и логические значения.

ResourceGroupValue

Представляет группу ресурсов Azure.

Имя Тип Описание
location

string

Расположение группы ресурсов.

name

string

minLength: 1
maxLength: 90

Имя группы ресурсов.

SecretValueReference

Ссылка на секрет Key Vault.

Имя Тип Описание
keyVault

keyVaultReference

Указывает ссылку на определенное хранилище ключей Azure.

secretName

string

Имя секрета.

secretVersion

string

Используемая версия секрета. Если осталось пустым, используется последняя версия секрета.

UserAssignedIdentity

Назначаемое пользователем управляемое удостоверение.

Имя Тип Описание
clientId

string

Идентификатор клиентского приложения, связанный с этим удостоверением.

principalId

string

Идентификатор субъекта Azure Active Directory, связанный с этим удостоверением.