Share via


RoleAssignmentArtifact Class

Definition

Blueprint artifact that applies a Role assignment.

public class RoleAssignmentArtifact : Azure.ResourceManager.Blueprint.ArtifactData
type RoleAssignmentArtifact = class
    inherit ArtifactData
Public Class RoleAssignmentArtifact
Inherits ArtifactData
Inheritance
RoleAssignmentArtifact

Constructors

RoleAssignmentArtifact(String, BinaryData)

Initializes a new instance of RoleAssignmentArtifact.

Properties

DependsOn

Artifacts which need to be deployed before the specified artifact.

Description

Multi-line explain this resource.

DisplayName

One-liner string explain this resource.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Name

The name of the resource.

(Inherited from ResourceData)
PrincipalIds

Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

ResourceGroup

RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
RoleDefinitionId

Azure resource ID of the RoleDefinition.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Applies to