Assignments - Create Or Update

Usługa:: Blueprints

Wersja interfejsu API:: 2018-11-01-preview

Tworzenie lub aktualizowanie przypisania strategii.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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

Nazwa	Wymagane	Typ	Opis
identity	True	ManagedServiceIdentity	Tożsamość zarządzana dla tego przypisania strategii.
location	True	string	Lokalizacja tego przypisania strategii.
properties.parameters	True	<string, ParameterValue>	Wartości parametrów przypisania strategii.
properties.resourceGroups	True	<string, ResourceGroupValue>	Nazwy i lokalizacje symboli zastępczych grupy zasobów.
properties.blueprintId		string	Identyfikator opublikowanej wersji definicji strategii.
properties.description		string maxLength: 500	Wiele wierszy wyjaśnia ten zasób.
properties.displayName		string maxLength: 256	Jeden ciąg liniowy wyjaśnia ten zasób.
properties.locks		AssignmentLockSettings	Definiuje sposób blokowania zasobów wdrożonych przez przypisanie strategii.
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

Nazwa	Typ	Opis
201 Created	Assignment	Utworzono — zapisano przypisanie strategii.
Other Status Codes	CloudError	Odpowiedź na błąd strategii.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Assignment	Reprezentuje przypisanie strategii.
AssignmentLockMode	Tryb blokady.
AssignmentLockSettings	Definiuje sposób blokowania zasobów wdrożonych przez przypisanie strategii.
AssignmentProvisioningState	Stan przypisania strategii.
AssignmentStatus	Stan przypisania strategii. To pole jest czytelne.
CloudError
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
keyVaultReference	Określa link do usługi Key Vault.
ManagedServiceIdentity	Obiekt ogólny tożsamości zarządzanej.
ManagedServiceIdentityType	Typ tożsamości zarządzanej.
ParameterValue	Wartość określonego parametru. Może to być wartość "wartość" lub "odwołanie", ale nie oba.
ResourceGroupValue	Reprezentuje grupę zasobów platformy Azure.
SecretValueReference	Odwołanie do wpisu tajnego usługi Key Vault.
UserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika.

Assignment

Objekt

Reprezentuje przypisanie strategii.

Nazwa	Typ	Opis
id	string	Identyfikator ciągu używany do lokalizowania dowolnego zasobu na platformie Azure.
identity	ManagedServiceIdentity	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 maxLength: 500	Wiele wierszy wyjaśnia ten zasób.
properties.displayName	string maxLength: 256	Jeden ciąg liniowy wyjaśnia ten zasób.
properties.locks	AssignmentLockSettings	Definiuje sposób blokowania zasobów wdrożonych przez przypisanie strategii.
properties.parameters	<string, ParameterValue>	Wartości parametrów przypisania strategii.
properties.provisioningState	AssignmentProvisioningState	Stan przypisania strategii.
properties.resourceGroups	<string, ResourceGroupValue>	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	AssignmentStatus	Stan przypisania strategii. To pole jest czytelne.
type	string	Typ tego zasobu.

AssignmentLockMode

Wyliczanie

Tryb blokady.

Wartość	Opis
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Objekt

Definiuje sposób blokowania zasobów wdrożonych przez przypisanie strategii.

Nazwa	Typ	Opis
excludedActions	string[]	Lista operacji zarządzania wykluczonych z blokad strategii. Dozwolone są maksymalnie 200 akcji. Jeśli tryb blokady jest ustawiony na 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 jest ustawiony na 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	AssignmentLockMode	Tryb blokady.

AssignmentProvisioningState

Wyliczanie

Stan przypisania strategii.

Wartość	Opis
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Objekt

Stan przypisania strategii. To pole jest czytelne.

Nazwa	Typ	Opis
lastModified	string (date-time)	Czas ostatniej modyfikacji tej definicji strategii.
managedResources	string[]	Lista zasobów utworzonych przez przypisanie strategii.
timeCreated	string (date-time)	Czas tworzenia tej definicji strategii.

CloudError

Objekt

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ErrorAdditionalInfo

Objekt

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

keyVaultReference

Objekt

Określa link do usługi Key Vault.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure usługi Key Vault.

ManagedServiceIdentity

Objekt

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

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory skojarzony z tą tożsamością.
tenantId	string	Identyfikator usługi Azure Active Directory.
type	ManagedServiceIdentityType	Typ tożsamości zarządzanej.
userAssignedIdentities	<string, UserAssignedIdentity>	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

Wyliczanie

Typ tożsamości zarządzanej.

Wartość	Opis
None
SystemAssigned
UserAssigned

ParameterValue

Objekt

Wartość określonego parametru. Może to być wartość "wartość" lub "odwołanie", ale nie oba.

Nazwa	Typ	Opis
reference	SecretValueReference	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

Objekt

Reprezentuje grupę zasobów platformy Azure.

Nazwa	Typ	Opis
location	string	Lokalizacja grupy zasobów.
name	string minLength: 1 maxLength: 90	Nazwa grupy zasobów.

SecretValueReference

Objekt

Odwołanie do wpisu tajnego usługi Key Vault.

Nazwa	Typ	Opis
keyVault	keyVaultReference	Określa odwołanie do danej usługi Azure Key Vault.
secretName	string	Nazwa wpisu tajnego.
secretVersion	string	Wersja wpisu tajnego do użycia. Jeśli pole pozostanie puste, zostanie użyta najnowsza wersja wpisu tajnego.

UserAssignedIdentity

Objekt

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

Nazwa	Typ	Opis
clientId	string	Identyfikator aplikacji klienckiej skojarzony z tą tożsamością.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory skojarzony z tą tożsamością.

Udostępnij przez

Assignments - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Assignment with system-assigned managed identity at management group scope

Przykładowe żądanie

Przykładowa odpowiedź

Assignment with system-assigned managed identity at subscription scope

Przykładowe żądanie

Przykładowa odpowiedź

Assignment with user-assigned managed identity at management group scope

Przykładowe żądanie

Przykładowa odpowiedź

Assignment with user-assigned managed identity at subscription scope

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Assignment

AssignmentLockMode

AssignmentLockSettings

AssignmentProvisioningState

AssignmentStatus

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ManagedServiceIdentity

ManagedServiceIdentityType

ParameterValue

ResourceGroupValue

SecretValueReference

UserAssignedIdentity