다음을 통해 공유


Assignments - Create Or Update

청사진 할당을 만들거나 업데이트합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
assignmentName
path True

string

청사진 할당의 이름입니다.

resourceScope
path True

string

리소스의 범위입니다. 유효한 범위는 관리 그룹(형식: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), 구독(형식: '/subscriptions/{subscriptionId}')입니다.

api-version
query True

string

클라이언트 API 버전입니다.

요청 본문

Name 필수 형식 Description
identity True

ManagedServiceIdentity

이 청사진 할당에 대한 관리 ID입니다.

location True

string

이 청사진 할당의 위치입니다.

properties.parameters True

<string,  ParameterValue>

청사진 할당 매개 변수 값입니다.

properties.resourceGroups True

<string,  ResourceGroupValue>

리소스 그룹 자리 표시자의 이름 및 위치입니다.

properties.blueprintId

string

게시된 청사진 정의 버전의 ID입니다.

properties.description

string

maxLength: 500

이 리소스를 여러 줄로 설명합니다.

properties.displayName

string

maxLength: 256

한 줄 문자열은 이 리소스를 설명합니다.

properties.locks

AssignmentLockSettings

청사진 할당에 의해 배포된 리소스가 잠기는 방법을 정의합니다.

properties.scope

string

청사진 할당의 대상 구독 범위입니다(형식: '/subscriptions/{subscriptionId}'). 관리 그룹 수준 할당의 경우 속성이 필요합니다.

응답

Name 형식 Description
201 Created

Assignment

만든 -- 청사진 할당이 저장되었습니다.

Other Status Codes

CloudError

청사진 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

정의

Name Description
Assignment

청사진 할당을 나타냅니다.

AssignmentLockMode

잠금 모드입니다.

AssignmentLockSettings

청사진 할당에 의해 배포된 리소스가 잠기는 방법을 정의합니다.

AssignmentProvisioningState

청사진 할당의 상태입니다.

AssignmentStatus

청사진 할당의 상태입니다. 이 필드는 읽기 전용입니다.

CloudError
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorResponse

오류 응답

keyVaultReference

Key Vault에 대한 링크를 지정합니다.

ManagedServiceIdentity

관리 ID 제네릭 개체입니다.

ManagedServiceIdentityType

관리 ID의 형식입니다.

ParameterValue

지정된 매개 변수의 값입니다. 'value' 또는 'reference'일 수 있지만 둘 다일 수는 없습니다.

ResourceGroupValue

Azure 리소스 그룹을 나타냅니다.

SecretValueReference

Key Vault 비밀에 대한 참조입니다.

UserAssignedIdentity

사용자가 할당한 관리 ID입니다.

Assignment

청사진 할당을 나타냅니다.

Name 형식 Description
id

string

Azure에서 리소스를 찾는 데 사용되는 문자열 ID입니다.

identity

ManagedServiceIdentity

이 청사진 할당에 대한 관리 ID입니다.

location

string

이 청사진 할당의 위치입니다.

name

string

이 리소스의 이름입니다.

properties.blueprintId

string

게시된 청사진 정의 버전의 ID입니다.

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

잠금 모드입니다.

Description
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

청사진 할당에 의해 배포된 리소스가 잠기는 방법을 정의합니다.

Name 형식 Description
excludedActions

string[]

청사진 잠금에서 제외되는 관리 작업 목록입니다. 최대 200개까지 작업이 허용됩니다. 잠금 모드가 'AllResourcesReadOnly'로 설정된 경우 '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' 및 'Microsoft.Authorization/locks/delete' 작업이 'excludedActions'에 자동으로 추가됩니다. 잠금 모드가 'AllResourcesDoNotDelete'로 설정된 경우 'excludedActions'에 다음 작업이 자동으로 추가됩니다. 'Microsoft.Authorization/locks/delete'. 중복 작업이 제거됩니다.

excludedPrincipals

string[]

청사진 잠금에서 제외된 AAD 보안 주체 목록입니다. 최대 5개의 보안 주체가 허용됩니다.

mode

AssignmentLockMode

잠금 모드입니다.

AssignmentProvisioningState

청사진 할당의 상태입니다.

Description
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

청사진 할당의 상태입니다. 이 필드는 읽기 전용입니다.

Name 형식 Description
lastModified

string (date-time)

이 청사진 정의의 마지막으로 수정된 시간입니다.

managedResources

string[]

청사진 할당에서 만든 리소스 목록입니다.

timeCreated

string (date-time)

이 청사진 정의의 생성 시간입니다.

CloudError

Name 형식 Description
error

ErrorResponse

오류 응답
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorResponse

오류 응답

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.

code

string

오류 코드입니다.

details

ErrorResponse[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

keyVaultReference

Key Vault에 대한 링크를 지정합니다.

Name 형식 Description
id

string

Key Vault의 Azure 리소스 ID입니다.

ManagedServiceIdentity

관리 ID 제네릭 개체입니다.

Name 형식 Description
principalId

string

이 ID와 연결된 Azure Active Directory 보안 주체 ID입니다.

tenantId

string

Azure Active Directory의 ID입니다.

type

ManagedServiceIdentityType

관리 ID의 형식입니다.

userAssignedIdentities

<string,  UserAssignedIdentity>

리소스와 연결된 사용자 할당 관리 ID 목록입니다. 키는 관리 ID의 Azure 리소스 ID입니다.

ManagedServiceIdentityType

관리 ID의 형식입니다.

Description
None
SystemAssigned
UserAssigned

ParameterValue

지정된 매개 변수의 값입니다. 'value' 또는 'reference'일 수 있지만 둘 다일 수는 없습니다.

Name 형식 Description
reference

SecretValueReference

매개 변수 값을 참조 형식으로 사용합니다.

value

object

매개 변수 값입니다. 개체, 배열, 문자열, 숫자 및 부울을 포함하여 유효한 모든 JSON 값이 허용됩니다.

ResourceGroupValue

Azure 리소스 그룹을 나타냅니다.

Name 형식 Description
location

string

리소스 그룹의 위치입니다.

name

string

minLength: 1
maxLength: 90

리소스 그룹의 이름입니다.

SecretValueReference

Key Vault 비밀에 대한 참조입니다.

Name 형식 Description
keyVault

keyVaultReference

지정된 Azure Key Vault에 대한 참조를 지정합니다.

secretName

string

비밀의 이름입니다.

secretVersion

string

사용할 비밀의 버전입니다. 비워 두면 최신 버전의 비밀이 사용됩니다.

UserAssignedIdentity

사용자가 할당한 관리 ID입니다.

Name 형식 Description
clientId

string

이 ID와 연결된 클라이언트 앱 ID입니다.

principalId

string

이 ID와 연결된 Azure Active Directory 보안 주체 ID입니다.