Assignments - Create Or Update

Referencia

Servicio:: Blueprints

Versión de la API:: 2018-11-01-preview

Cree o actualice una asignación de plano técnico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
assignmentName	path	True	string	Nombre de la asignación de plano técnico.
resourceScope	path	True	string	Ámbito del recurso. Los ámbitos válidos son: grupo de administración (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}').
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
identity	True	ManagedServiceIdentity	Identidad administrada para esta asignación de plano técnico.
location	True	string	Ubicación de esta asignación de plano técnico.
properties.parameters	True	<string, ParameterValue>	Valores de parámetros de asignación de plano técnico.
properties.resourceGroups	True	<string, ResourceGroupValue>	Nombres y ubicaciones de marcadores de posición del grupo de recursos.
properties.blueprintId		string	Identificador de la versión publicada de una definición de plano técnico.
properties.description		string maxLength: 500	En varias líneas se explica este recurso.
properties.displayName		string maxLength: 256	Una cadena de línea explica este recurso.
properties.locks		AssignmentLockSettings	Define cómo se bloquean los recursos implementados por una asignación de plano técnico.
properties.scope		string	El ámbito de la suscripción de destino de la asignación de plano técnico (formato: '/subscriptions/{subscriptionId}'). Para las asignaciones de nivel de grupo de administración, se requiere la propiedad .

Respuestas

Nombre	Tipo	Description
201 Created	Assignment	Creado: asignación de plano técnico guardada.
Other Status Codes	CloudError	Respuesta de error de planos técnicos.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Solicitud de ejemplo

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

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Create_SystemAssignedMSI.json
func ExampleAssignmentsClient_CreateOrUpdate_assignmentWithSystemAssignedManagedIdentityAtManagementGroupScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewAssignmentsClient().CreateOrUpdate(ctx, "managementGroups/ContosoOnlineGroup", "assignSimpleBlueprint", armblueprint.Assignment{
		Location: to.Ptr("eastus"),
		Identity: &armblueprint.ManagedServiceIdentity{
			Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeSystemAssigned),
		},
		Properties: &armblueprint.AssignmentProperties{
			Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Parameters: map[string]*armblueprint.ParameterValue{
				"costCenter": {
					Value: "Contoso/Online/Shopping/Production",
				},
				"owners": {
					Value: []any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": {
					Value: "Standard_LRS",
				},
			},
			ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
				"storageRG": {
					Name:     to.Ptr("defaultRG"),
					Location: to.Ptr("eastus"),
				},
			},
			Scope: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Create_SystemAssignedMSI.json
// this example is just showing the usage of "Assignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AssignmentResource created on azure
// for more information of creating AssignmentResource, please refer to the document of AssignmentResource
string resourceScope = "managementGroups/ContosoOnlineGroup";
string assignmentName = "assignSimpleBlueprint";
ResourceIdentifier assignmentResourceId = AssignmentResource.CreateResourceIdentifier(resourceScope, assignmentName);
AssignmentResource assignment = client.GetAssignmentResource(assignmentResourceId);

// invoke the operation
AssignmentData data = new AssignmentData(new Models.ManagedServiceIdentity(ManagedServiceIdentityType.SystemAssigned), new Dictionary<string, ParameterValue>()
{
    ["costCenter"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Contoso/Online/Shopping/Production"),
    },
    ["owners"] = new ParameterValue()
    {
        Value = BinaryData.FromObjectAsJson(new object[] { "johnDoe@contoso.com", "johnsteam@contoso.com" }),
    },
    ["storageAccountType"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Standard_LRS"),
    },
}, new Dictionary<string, ResourceGroupValue>()
{
    ["storageRG"] = new ResourceGroupValue()
    {
        Name = "defaultRG",
        Location = new AzureLocation("eastus"),
    },
}, new AzureLocation("eastus"))
{
    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",
};
ArmOperation<AssignmentResource> lro = await assignment.UpdateAsync(WaitUntil.Completed, data);
AssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Create_SystemAssignedMSI.json
func ExampleAssignmentsClient_CreateOrUpdate_assignmentWithSystemAssignedManagedIdentityAtSubscriptionScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewAssignmentsClient().CreateOrUpdate(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", "assignSimpleBlueprint", armblueprint.Assignment{
		Location: to.Ptr("eastus"),
		Identity: &armblueprint.ManagedServiceIdentity{
			Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeSystemAssigned),
		},
		Properties: &armblueprint.AssignmentProperties{
			Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Parameters: map[string]*armblueprint.ParameterValue{
				"costCenter": {
					Value: "Contoso/Online/Shopping/Production",
				},
				"owners": {
					Value: []any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": {
					Value: "Standard_LRS",
				},
			},
			ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
				"storageRG": {
					Name:     to.Ptr("defaultRG"),
					Location: to.Ptr("eastus"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Create_SystemAssignedMSI.json
// this example is just showing the usage of "Assignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AssignmentResource created on azure
// for more information of creating AssignmentResource, please refer to the document of AssignmentResource
string resourceScope = "subscriptions/00000000-0000-0000-0000-000000000000";
string assignmentName = "assignSimpleBlueprint";
ResourceIdentifier assignmentResourceId = AssignmentResource.CreateResourceIdentifier(resourceScope, assignmentName);
AssignmentResource assignment = client.GetAssignmentResource(assignmentResourceId);

// invoke the operation
AssignmentData data = new AssignmentData(new Models.ManagedServiceIdentity(ManagedServiceIdentityType.SystemAssigned), new Dictionary<string, ParameterValue>()
{
    ["costCenter"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Contoso/Online/Shopping/Production"),
    },
    ["owners"] = new ParameterValue()
    {
        Value = BinaryData.FromObjectAsJson(new object[] { "johnDoe@contoso.com", "johnsteam@contoso.com" }),
    },
    ["storageAccountType"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Standard_LRS"),
    },
}, new Dictionary<string, ResourceGroupValue>()
{
    ["storageRG"] = new ResourceGroupValue()
    {
        Name = "defaultRG",
        Location = new AzureLocation("eastus"),
    },
}, new AzureLocation("eastus"))
{
    Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
};
ArmOperation<AssignmentResource> lro = await assignment.UpdateAsync(WaitUntil.Completed, data);
AssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Create_UserAssignedMSI.json
func ExampleAssignmentsClient_CreateOrUpdate_assignmentWithUserAssignedManagedIdentityAtManagementGroupScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewAssignmentsClient().CreateOrUpdate(ctx, "managementGroups/ContosoOnlineGroup", "assignSimpleBlueprint", armblueprint.Assignment{
		Location: to.Ptr("eastus"),
		Identity: &armblueprint.ManagedServiceIdentity{
			Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armblueprint.UserAssignedIdentity{
				"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {},
			},
		},
		Properties: &armblueprint.AssignmentProperties{
			Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Parameters: map[string]*armblueprint.ParameterValue{
				"costCenter": {
					Value: "Contoso/Online/Shopping/Production",
				},
				"owners": {
					Value: []any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": {
					Value: "Standard_LRS",
				},
			},
			ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
				"storageRG": {
					Name:     to.Ptr("defaultRG"),
					Location: to.Ptr("eastus"),
				},
			},
			Scope: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Create_UserAssignedMSI.json
// this example is just showing the usage of "Assignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AssignmentResource created on azure
// for more information of creating AssignmentResource, please refer to the document of AssignmentResource
string resourceScope = "managementGroups/ContosoOnlineGroup";
string assignmentName = "assignSimpleBlueprint";
ResourceIdentifier assignmentResourceId = AssignmentResource.CreateResourceIdentifier(resourceScope, assignmentName);
AssignmentResource assignment = client.GetAssignmentResource(assignmentResourceId);

// invoke the operation
AssignmentData data = new AssignmentData(new Models.ManagedServiceIdentity(ManagedServiceIdentityType.UserAssigned)
{
    UserAssignedIdentities =
    {
    ["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity"] = new UserAssignedIdentity(),
    },
}, new Dictionary<string, ParameterValue>()
{
    ["costCenter"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Contoso/Online/Shopping/Production"),
    },
    ["owners"] = new ParameterValue()
    {
        Value = BinaryData.FromObjectAsJson(new object[] { "johnDoe@contoso.com", "johnsteam@contoso.com" }),
    },
    ["storageAccountType"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Standard_LRS"),
    },
}, new Dictionary<string, ResourceGroupValue>()
{
    ["storageRG"] = new ResourceGroupValue()
    {
        Name = "defaultRG",
        Location = new AzureLocation("eastus"),
    },
}, new AzureLocation("eastus"))
{
    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",
};
ArmOperation<AssignmentResource> lro = await assignment.UpdateAsync(WaitUntil.Completed, data);
AssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Create_UserAssignedMSI.json
func ExampleAssignmentsClient_CreateOrUpdate_assignmentWithUserAssignedManagedIdentityAtSubscriptionScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewAssignmentsClient().CreateOrUpdate(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", "assignSimpleBlueprint", armblueprint.Assignment{
		Location: to.Ptr("eastus"),
		Identity: &armblueprint.ManagedServiceIdentity{
			Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armblueprint.UserAssignedIdentity{
				"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {},
			},
		},
		Properties: &armblueprint.AssignmentProperties{
			Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Parameters: map[string]*armblueprint.ParameterValue{
				"costCenter": {
					Value: "Contoso/Online/Shopping/Production",
				},
				"owners": {
					Value: []any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": {
					Value: "Standard_LRS",
				},
			},
			ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
				"storageRG": {
					Name:     to.Ptr("defaultRG"),
					Location: to.Ptr("eastus"),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Blueprint;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Models;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Create_UserAssignedMSI.json
// this example is just showing the usage of "Assignments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AssignmentResource created on azure
// for more information of creating AssignmentResource, please refer to the document of AssignmentResource
string resourceScope = "subscriptions/00000000-0000-0000-0000-000000000000";
string assignmentName = "assignSimpleBlueprint";
ResourceIdentifier assignmentResourceId = AssignmentResource.CreateResourceIdentifier(resourceScope, assignmentName);
AssignmentResource assignment = client.GetAssignmentResource(assignmentResourceId);

// invoke the operation
AssignmentData data = new AssignmentData(new Models.ManagedServiceIdentity(ManagedServiceIdentityType.UserAssigned)
{
    UserAssignedIdentities =
    {
    ["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity"] = new UserAssignedIdentity(),
    },
}, new Dictionary<string, ParameterValue>()
{
    ["costCenter"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Contoso/Online/Shopping/Production"),
    },
    ["owners"] = new ParameterValue()
    {
        Value = BinaryData.FromObjectAsJson(new object[] { "johnDoe@contoso.com", "johnsteam@contoso.com" }),
    },
    ["storageAccountType"] = new ParameterValue()
    {
        Value = BinaryData.FromString("Standard_LRS"),
    },
}, new Dictionary<string, ResourceGroupValue>()
{
    ["storageRG"] = new ResourceGroupValue()
    {
        Name = "defaultRG",
        Location = new AzureLocation("eastus"),
    },
}, new AzureLocation("eastus"))
{
    Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
};
ArmOperation<AssignmentResource> lro = await assignment.UpdateAsync(WaitUntil.Completed, data);
AssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
Assignment	Representa una asignación de plano técnico.
AssignmentLockMode	Modo de bloqueo.
AssignmentLockSettings	Define cómo se bloquean los recursos implementados por una asignación de plano técnico.
AssignmentProvisioningState	Estado de la asignación del plano técnico.
AssignmentStatus	Estado de una asignación de plano técnico. Este campo es de solo lectura.
CloudError
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
keyVaultReference	Especifica el vínculo a un almacén de claves.
ManagedServiceIdentity	Objeto genérico de identidad administrada.
ManagedServiceIdentityType	Tipo de la identidad administrada.
ParameterValue	Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.
ResourceGroupValue	Representa un grupo de recursos de Azure.
SecretValueReference	Referencia a un secreto de Key Vault.
UserAssignedIdentity	Identidad administrada asignada por el usuario.

Assignment

Object

Representa una asignación de plano técnico.

Nombre	Tipo	Description
id	string	Identificador de cadena usado para buscar cualquier recurso en Azure.
identity	ManagedServiceIdentity	Identidad administrada para esta asignación de plano técnico.
location	string	Ubicación de esta asignación de plano técnico.
name	string	Nombre de este recurso.
properties.blueprintId	string	Identificador de la versión publicada de una definición de plano técnico.
properties.description	string maxLength: 500	En varias líneas se explica este recurso.
properties.displayName	string maxLength: 256	Una cadena de línea explica este recurso.
properties.locks	AssignmentLockSettings	Define cómo se bloquean los recursos implementados por una asignación de plano técnico.
properties.parameters	<string, ParameterValue>	Valores de parámetros de asignación de plano técnico.
properties.provisioningState	AssignmentProvisioningState	Estado de la asignación del plano técnico.
properties.resourceGroups	<string, ResourceGroupValue>	Nombres y ubicaciones de marcadores de posición del grupo de recursos.
properties.scope	string	El ámbito de la suscripción de destino de la asignación de plano técnico (formato: '/subscriptions/{subscriptionId}'). Para las asignaciones de nivel de grupo de administración, se requiere la propiedad .
properties.status	AssignmentStatus	Estado de la asignación de plano técnico. Este campo es de solo lectura.
type	string	Tipo de este recurso.

AssignmentLockMode

Enumeración

Modo de bloqueo.

Valor	Description
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

Object

Define cómo se bloquean los recursos implementados por una asignación de plano técnico.

Nombre	Tipo	Description
excludedActions	string[]	Lista de operaciones de administración que se excluyen de los bloqueos de plano técnico. Se permiten hasta 200 acciones. Si el modo de bloqueo se establece en "AllResourcesReadOnly", las siguientes acciones se anexan automáticamente a "excludedActions": "*/read", "Microsoft.Network/virtualNetworks/subnets/join/action" y "Microsoft.Authorization/locks/delete". Si el modo de bloqueo se establece en "AllResourcesDoNotDelete", las siguientes acciones se anexan automáticamente a "excludedActions": "Microsoft.Authorization/locks/delete". Se quitarán las acciones duplicadas.
excludedPrincipals	string[]	Lista de entidades de seguridad de AAD excluidas de los bloqueos de plano técnico. Se permiten hasta 5 entidades de seguridad.
mode	AssignmentLockMode	Modo de bloqueo.

AssignmentProvisioningState

Enumeración

Estado de la asignación del plano técnico.

Valor	Description
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

Object

Estado de una asignación de plano técnico. Este campo es de solo lectura.

Nombre	Tipo	Description
lastModified	string (date-time)	Hora de última modificación de esta definición de plano técnico.
managedResources	string[]	Lista de recursos creados por la asignación de plano técnico.
timeCreated	string (date-time)	Hora de creación de esta definición de plano técnico.

CloudError

Object

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

keyVaultReference

Object

Especifica el vínculo a un almacén de claves.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure del almacén de claves.

ManagedServiceIdentity

Object

Objeto genérico de identidad administrada.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de Azure Active Directory asociado a esta identidad.
tenantId	string	Identificador de Azure Active Directory.
type	ManagedServiceIdentityType	Tipo de la identidad administrada.
userAssignedIdentities	<string, UserAssignedIdentity>	Lista de identidades administradas asignadas por el usuario asociadas al recurso. La clave es el identificador de recurso de Azure de la identidad administrada.

ManagedServiceIdentityType

Enumeración

Tipo de la identidad administrada.

Valor	Description
None
SystemAssigned
UserAssigned

ParameterValue

Object

Valor del parámetro especificado. Puede ser "value" o "reference", pero no ambos.

Nombre	Tipo	Description
reference	SecretValueReference	Valor de parámetro como tipo de referencia.
value	object	Valor del parámetro. Se permite cualquier valor JSON válido, incluidos objetos, matrices, cadenas, números y booleanos.

ResourceGroupValue

Object

Representa un grupo de recursos de Azure.

Nombre	Tipo	Description
location	string	Ubicación del grupo de recursos.
name	string minLength: 1 maxLength: 90	Nombre del grupo de recursos.

SecretValueReference

Object

Referencia a un secreto de Key Vault.

Nombre	Tipo	Description
keyVault	keyVaultReference	Especifica la referencia a una instancia de Azure Key Vault determinada.
secretName	string	Nombre del secreto.
secretVersion	string	Versión del secreto que se va a usar. Si se deja en blanco, se usa la versión más reciente del secreto.

UserAssignedIdentity

Object

Identidad administrada asignada por el usuario.

Nombre	Tipo	Description
clientId	string	Id. de aplicación cliente asociado a esta identidad.
principalId	string	Identificador de entidad de seguridad de Azure Active Directory asociado a esta identidad.

Compartir a través de

Assignments - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Assignment with system-assigned managed identity at management group scope

Solicitud de ejemplo

Respuesta de muestra

Assignment with system-assigned managed identity at subscription scope

Solicitud de ejemplo

Respuesta de muestra

Assignment with user-assigned managed identity at management group scope

Solicitud de ejemplo

Respuesta de muestra

Assignment with user-assigned managed identity at subscription scope

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Assignment

AssignmentLockMode

AssignmentLockSettings

AssignmentProvisioningState

AssignmentStatus

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ManagedServiceIdentity

ManagedServiceIdentityType

ParameterValue

ResourceGroupValue

SecretValueReference

UserAssignedIdentity

Recursos adicionales