Assignments - Create Or Update

Utwórz lub zaktualizuj przypisanie strategii.

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

Parametry identyfikatora URI

Name In Required Type Description
assignmentName
path True
  • string

Nazwa przypisania strategii.

resourceScope
path True
  • string

Zakres zasobu. Prawidłowe zakresy to: grupa zarządzania (format: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), subskrypcja (format: "/subscriptions/{subscriptionId}").

api-version
query True
  • string

Wersja interfejsu API klienta.

Treść żądania

Name Required Type Description
identity True

Tożsamość zarządzana dla tego przypisania strategii.

location True
  • string

Lokalizacja tego przypisania strategii.

properties.parameters True

Wartości parametrów przypisania strategii.

properties.resourceGroups True

Nazwy i lokalizacje symboli zastępczych grupy zasobów.

properties.blueprintId
  • string

Identyfikator opublikowanej wersji definicji strategii.

properties.description
  • string

Wiele wierszy wyjaśnia ten zasób.

properties.displayName
  • string

Jeden ciąg liniowy wyjaśnia ten zasób.

properties.locks

Definiuje sposób, w jaki zasoby wdrażane przez przypisanie strategii są zablokowane.

properties.scope
  • string

Docelowy zakres subskrypcji przypisania strategii (format: "/subscriptions/{subscriptionId}"). W przypadku przypisań na poziomie grupy zarządzania właściwość jest wymagana.

Odpowiedzi

Name Type Description
201 Created

Utworzono — zapisano przypisanie strategii.

Other Status Codes

Odpowiedź na błędy strategii.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

Assignment

Reprezentuje przypisanie strategii.

AssignmentLockMode

Tryb blokady.

AssignmentLockSettings

Definiuje sposób, w jaki zasoby wdrażane przez przypisanie strategii są zablokowane.

AssignmentProvisioningState

Stan przypisania strategii.

AssignmentStatus

Stan przypisania strategii. To pole jest odczytywane.

CloudError
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorResponse

Odpowiedź na błąd

keyVaultReference

Określa link do Key Vault.

ManagedServiceIdentity

Obiekt ogólny tożsamości zarządzanej.

ManagedServiceIdentityType

Typ tożsamości zarządzanej.

ParameterValue

Wartość dla określonego parametru. Może to być wartość "value" lub "reference", ale nie oba te elementy.

ResourceGroupValue

Reprezentuje grupę zasobów platformy Azure.

SecretValueReference

Odwołanie do wpisu tajnego Key Vault.

UserAssignedIdentity

Tożsamość zarządzana przypisana przez użytkownika.

Assignment

Reprezentuje przypisanie strategii.

Name Type Description
id
  • string

Identyfikator ciągu używany do lokalizowania dowolnego zasobu na platformie Azure.

identity

Tożsamość zarządzana dla tego przypisania strategii.

location
  • string

Lokalizacja tego przypisania strategii.

name
  • string

Nazwa tego zasobu.

properties.blueprintId
  • string

Identyfikator opublikowanej wersji definicji strategii.

properties.description
  • string

Wiele wierszy wyjaśnia ten zasób.

properties.displayName
  • string

Jeden ciąg liniowy wyjaśnia ten zasób.

properties.locks

Definiuje sposób, w jaki zasoby wdrażane przez przypisanie strategii są zablokowane.

properties.parameters

Wartości parametrów przypisania strategii.

properties.provisioningState

Stan przypisania strategii.

properties.resourceGroups

Nazwy i lokalizacje symboli zastępczych grupy zasobów.

properties.scope
  • string

Docelowy zakres subskrypcji przypisania strategii (format: "/subscriptions/{subscriptionId}"). W przypadku przypisań na poziomie grupy zarządzania właściwość jest wymagana.

properties.status

Stan przypisania strategii. To pole jest odczytywane.

type
  • string

Typ tego zasobu.

AssignmentLockMode

Tryb blokady.

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

AssignmentLockSettings

Definiuje sposób, w jaki zasoby wdrażane przez przypisanie strategii są zablokowane.

Name Type Description
excludedActions
  • string[]

Lista operacji zarządzania, które są wykluczone z blokad strategii. Dozwolone są maksymalnie 200 akcji. Jeśli tryb blokady ma wartość "AllResourcesReadOnly", następujące akcje są automatycznie dołączane do "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" i "Microsoft.Authorization/locks/delete". Jeśli tryb blokady ma wartość "AllResourcesDoNotDelete", następujące akcje są automatycznie dołączane do "excludedActions": "Microsoft.Authorization/locks/delete". Zduplikowane akcje zostaną usunięte.

excludedPrincipals
  • string[]

Lista podmiotów zabezpieczeń usługi AAD wykluczonych z blokad strategii. Dozwolone są maksymalnie 5 podmiotów zabezpieczeń.

mode

Tryb blokady.

AssignmentProvisioningState

Stan przypisania strategii.

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

AssignmentStatus

Stan przypisania strategii. To pole jest odczytywane.

Name Type Description
lastModified
  • string

Czas ostatniej modyfikacji tej definicji strategii.

managedResources
  • string[]

Lista zasobów utworzonych przez przypisanie strategii.

timeCreated
  • string

Czas tworzenia tej definicji strategii.

CloudError

Name Type Description
error

Odpowiedź na błąd
Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

keyVaultReference

Określa link do Key Vault.

Name Type Description
id
  • string

Identyfikator zasobu platformy Azure Key Vault.

ManagedServiceIdentity

Obiekt ogólny tożsamości zarządzanej.

Name Type Description
principalId
  • string

Azure Active Directory identyfikator podmiotu zabezpieczeń skojarzonego z tą tożsamością.

tenantId
  • string

Identyfikator Azure Active Directory.

type

Typ tożsamości zarządzanej.

userAssignedIdentities

Lista tożsamości zarządzanych przypisanych przez użytkownika skojarzonych z zasobem. Klucz to identyfikator zasobu platformy Azure tożsamości zarządzanej.

ManagedServiceIdentityType

Typ tożsamości zarządzanej.

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

ParameterValue

Wartość dla określonego parametru. Może to być wartość "value" lub "reference", ale nie oba te elementy.

Name Type Description
reference

Wartość parametru jako typ odwołania.

value
  • object

Wartość parametru. Każda prawidłowa wartość JSON jest dozwolona, w tym obiekty, tablice, ciągi, liczby i wartości logiczne.

ResourceGroupValue

Reprezentuje grupę zasobów platformy Azure.

Name Type Description
location
  • string

Lokalizacja grupy zasobów.

name
  • string

Nazwa grupy zasobów.

SecretValueReference

Odwołanie do wpisu tajnego Key Vault.

Name Type Description
keyVault

Określa odwołanie do danej Key Vault platformy Azure.

secretName
  • string

Nazwa wpisu tajnego.

secretVersion
  • string

Wersja wpisu tajnego do użycia. Jeśli pozostawisz pole puste, zostanie użyta najnowsza wersja wpisu tajnego.

UserAssignedIdentity

Tożsamość zarządzana przypisana przez użytkownika.

Name Type Description
clientId
  • string

Identyfikator aplikacji klienckiej skojarzony z tą tożsamością.

principalId
  • string

Azure Active Directory identyfikator podmiotu zabezpieczeń skojarzonego z tą tożsamością.