1. Packages
  2. Azure Native
  3. API Docs
  4. blueprint
  5. getAssignment
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.blueprint.getAssignment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Get a blueprint assignment. Azure REST API version: 2018-11-01-preview.

    Other available API versions: 2017-11-11-preview.

    Using getAssignment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAssignment(args: GetAssignmentArgs, opts?: InvokeOptions): Promise<GetAssignmentResult>
    function getAssignmentOutput(args: GetAssignmentOutputArgs, opts?: InvokeOptions): Output<GetAssignmentResult>
    def get_assignment(assignment_name: Optional[str] = None,
                       resource_scope: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAssignmentResult
    def get_assignment_output(assignment_name: Optional[pulumi.Input[str]] = None,
                       resource_scope: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAssignmentResult]
    func LookupAssignment(ctx *Context, args *LookupAssignmentArgs, opts ...InvokeOption) (*LookupAssignmentResult, error)
    func LookupAssignmentOutput(ctx *Context, args *LookupAssignmentOutputArgs, opts ...InvokeOption) LookupAssignmentResultOutput

    > Note: This function is named LookupAssignment in the Go SDK.

    public static class GetAssignment 
    {
        public static Task<GetAssignmentResult> InvokeAsync(GetAssignmentArgs args, InvokeOptions? opts = null)
        public static Output<GetAssignmentResult> Invoke(GetAssignmentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAssignmentResult> getAssignment(GetAssignmentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:blueprint:getAssignment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AssignmentName string
    Name of the blueprint assignment.
    ResourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    AssignmentName string
    Name of the blueprint assignment.
    ResourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    assignmentName String
    Name of the blueprint assignment.
    resourceScope String
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    assignmentName string
    Name of the blueprint assignment.
    resourceScope string
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    assignment_name str
    Name of the blueprint assignment.
    resource_scope str
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
    assignmentName String
    Name of the blueprint assignment.
    resourceScope String
    The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

    getAssignment Result

    The following output properties are available:

    Id string
    String Id used to locate any resource on Azure.
    Identity Pulumi.AzureNative.Blueprint.Outputs.ManagedServiceIdentityResponse
    Managed identity for this blueprint assignment.
    Location string
    The location of this blueprint assignment.
    Name string
    Name of this resource.
    Parameters Dictionary<string, Pulumi.AzureNative.Blueprint.Outputs.ParameterValueResponse>
    Blueprint assignment parameter values.
    ProvisioningState string
    State of the blueprint assignment.
    ResourceGroups Dictionary<string, Pulumi.AzureNative.Blueprint.Outputs.ResourceGroupValueResponse>
    Names and locations of resource group placeholders.
    Status Pulumi.AzureNative.Blueprint.Outputs.AssignmentStatusResponse
    Status of blueprint assignment. This field is readonly.
    Type string
    Type of this resource.
    BlueprintId string
    ID of the published version of a blueprint definition.
    Description string
    Multi-line explain this resource.
    DisplayName string
    One-liner string explain this resource.
    Locks Pulumi.AzureNative.Blueprint.Outputs.AssignmentLockSettingsResponse
    Defines how resources deployed by a blueprint assignment are locked.
    Scope string
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
    Id string
    String Id used to locate any resource on Azure.
    Identity ManagedServiceIdentityResponse
    Managed identity for this blueprint assignment.
    Location string
    The location of this blueprint assignment.
    Name string
    Name of this resource.
    Parameters map[string]ParameterValueResponse
    Blueprint assignment parameter values.
    ProvisioningState string
    State of the blueprint assignment.
    ResourceGroups map[string]ResourceGroupValueResponse
    Names and locations of resource group placeholders.
    Status AssignmentStatusResponse
    Status of blueprint assignment. This field is readonly.
    Type string
    Type of this resource.
    BlueprintId string
    ID of the published version of a blueprint definition.
    Description string
    Multi-line explain this resource.
    DisplayName string
    One-liner string explain this resource.
    Locks AssignmentLockSettingsResponse
    Defines how resources deployed by a blueprint assignment are locked.
    Scope string
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
    id String
    String Id used to locate any resource on Azure.
    identity ManagedServiceIdentityResponse
    Managed identity for this blueprint assignment.
    location String
    The location of this blueprint assignment.
    name String
    Name of this resource.
    parameters Map<String,ParameterValueResponse>
    Blueprint assignment parameter values.
    provisioningState String
    State of the blueprint assignment.
    resourceGroups Map<String,ResourceGroupValueResponse>
    Names and locations of resource group placeholders.
    status AssignmentStatusResponse
    Status of blueprint assignment. This field is readonly.
    type String
    Type of this resource.
    blueprintId String
    ID of the published version of a blueprint definition.
    description String
    Multi-line explain this resource.
    displayName String
    One-liner string explain this resource.
    locks AssignmentLockSettingsResponse
    Defines how resources deployed by a blueprint assignment are locked.
    scope String
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
    id string
    String Id used to locate any resource on Azure.
    identity ManagedServiceIdentityResponse
    Managed identity for this blueprint assignment.
    location string
    The location of this blueprint assignment.
    name string
    Name of this resource.
    parameters {[key: string]: ParameterValueResponse}
    Blueprint assignment parameter values.
    provisioningState string
    State of the blueprint assignment.
    resourceGroups {[key: string]: ResourceGroupValueResponse}
    Names and locations of resource group placeholders.
    status AssignmentStatusResponse
    Status of blueprint assignment. This field is readonly.
    type string
    Type of this resource.
    blueprintId string
    ID of the published version of a blueprint definition.
    description string
    Multi-line explain this resource.
    displayName string
    One-liner string explain this resource.
    locks AssignmentLockSettingsResponse
    Defines how resources deployed by a blueprint assignment are locked.
    scope string
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
    id str
    String Id used to locate any resource on Azure.
    identity ManagedServiceIdentityResponse
    Managed identity for this blueprint assignment.
    location str
    The location of this blueprint assignment.
    name str
    Name of this resource.
    parameters Mapping[str, ParameterValueResponse]
    Blueprint assignment parameter values.
    provisioning_state str
    State of the blueprint assignment.
    resource_groups Mapping[str, ResourceGroupValueResponse]
    Names and locations of resource group placeholders.
    status AssignmentStatusResponse
    Status of blueprint assignment. This field is readonly.
    type str
    Type of this resource.
    blueprint_id str
    ID of the published version of a blueprint definition.
    description str
    Multi-line explain this resource.
    display_name str
    One-liner string explain this resource.
    locks AssignmentLockSettingsResponse
    Defines how resources deployed by a blueprint assignment are locked.
    scope str
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
    id String
    String Id used to locate any resource on Azure.
    identity Property Map
    Managed identity for this blueprint assignment.
    location String
    The location of this blueprint assignment.
    name String
    Name of this resource.
    parameters Map<Property Map>
    Blueprint assignment parameter values.
    provisioningState String
    State of the blueprint assignment.
    resourceGroups Map<Property Map>
    Names and locations of resource group placeholders.
    status Property Map
    Status of blueprint assignment. This field is readonly.
    type String
    Type of this resource.
    blueprintId String
    ID of the published version of a blueprint definition.
    description String
    Multi-line explain this resource.
    displayName String
    One-liner string explain this resource.
    locks Property Map
    Defines how resources deployed by a blueprint assignment are locked.
    scope String
    The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.

    Supporting Types

    AssignmentLockSettingsResponse

    ExcludedActions List<string>
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    ExcludedPrincipals List<string>
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    Mode string
    Lock mode.
    ExcludedActions []string
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    ExcludedPrincipals []string
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    Mode string
    Lock mode.
    excludedActions List<String>
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    excludedPrincipals List<String>
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    mode String
    Lock mode.
    excludedActions string[]
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    excludedPrincipals string[]
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    mode string
    Lock mode.
    excluded_actions Sequence[str]
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    excluded_principals Sequence[str]
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    mode str
    Lock mode.
    excludedActions List<String>
    List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed.
    excludedPrincipals List<String>
    List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
    mode String
    Lock mode.

    AssignmentStatusResponse

    LastModified string
    Last modified time of this blueprint definition.
    ManagedResources List<string>
    List of resources that were created by the blueprint assignment.
    TimeCreated string
    Creation time of this blueprint definition.
    LastModified string
    Last modified time of this blueprint definition.
    ManagedResources []string
    List of resources that were created by the blueprint assignment.
    TimeCreated string
    Creation time of this blueprint definition.
    lastModified String
    Last modified time of this blueprint definition.
    managedResources List<String>
    List of resources that were created by the blueprint assignment.
    timeCreated String
    Creation time of this blueprint definition.
    lastModified string
    Last modified time of this blueprint definition.
    managedResources string[]
    List of resources that were created by the blueprint assignment.
    timeCreated string
    Creation time of this blueprint definition.
    last_modified str
    Last modified time of this blueprint definition.
    managed_resources Sequence[str]
    List of resources that were created by the blueprint assignment.
    time_created str
    Creation time of this blueprint definition.
    lastModified String
    Last modified time of this blueprint definition.
    managedResources List<String>
    List of resources that were created by the blueprint assignment.
    timeCreated String
    Creation time of this blueprint definition.

    KeyVaultReferenceResponse

    Id string
    Azure resource ID of the Key Vault.
    Id string
    Azure resource ID of the Key Vault.
    id String
    Azure resource ID of the Key Vault.
    id string
    Azure resource ID of the Key Vault.
    id str
    Azure resource ID of the Key Vault.
    id String
    Azure resource ID of the Key Vault.

    ManagedServiceIdentityResponse

    Type string
    Type of the managed identity.
    PrincipalId string
    Azure Active Directory principal ID associated with this Identity.
    TenantId string
    ID of the Azure Active Directory.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Blueprint.Inputs.UserAssignedIdentityResponse>
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    Type string
    Type of the managed identity.
    PrincipalId string
    Azure Active Directory principal ID associated with this Identity.
    TenantId string
    ID of the Azure Active Directory.
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    type String
    Type of the managed identity.
    principalId String
    Azure Active Directory principal ID associated with this Identity.
    tenantId String
    ID of the Azure Active Directory.
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    type string
    Type of the managed identity.
    principalId string
    Azure Active Directory principal ID associated with this Identity.
    tenantId string
    ID of the Azure Active Directory.
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    type str
    Type of the managed identity.
    principal_id str
    Azure Active Directory principal ID associated with this Identity.
    tenant_id str
    ID of the Azure Active Directory.
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
    type String
    Type of the managed identity.
    principalId String
    Azure Active Directory principal ID associated with this Identity.
    tenantId String
    ID of the Azure Active Directory.
    userAssignedIdentities Map<Property Map>
    The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.

    ParameterValueResponse

    Reference Pulumi.AzureNative.Blueprint.Inputs.SecretValueReferenceResponse
    Parameter value as reference type.
    Value object
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    Reference SecretValueReferenceResponse
    Parameter value as reference type.
    Value interface{}
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value Object
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference SecretValueReferenceResponse
    Parameter value as reference type.
    value Any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
    reference Property Map
    Parameter value as reference type.
    value Any
    Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.

    ResourceGroupValueResponse

    Location string
    Location of the resource group.
    Name string
    Name of the resource group.
    Location string
    Location of the resource group.
    Name string
    Name of the resource group.
    location String
    Location of the resource group.
    name String
    Name of the resource group.
    location string
    Location of the resource group.
    name string
    Name of the resource group.
    location str
    Location of the resource group.
    name str
    Name of the resource group.
    location String
    Location of the resource group.
    name String
    Name of the resource group.

    SecretValueReferenceResponse

    KeyVault Pulumi.AzureNative.Blueprint.Inputs.KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    SecretName string
    Name of the secret.
    SecretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    KeyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    SecretName string
    Name of the secret.
    SecretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secretName String
    Name of the secret.
    secretVersion String
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secretName string
    Name of the secret.
    secretVersion string
    The version of the secret to use. If left blank, the latest version of the secret is used.
    key_vault KeyVaultReferenceResponse
    Specifies the reference to a given Azure Key Vault.
    secret_name str
    Name of the secret.
    secret_version str
    The version of the secret to use. If left blank, the latest version of the secret is used.
    keyVault Property Map
    Specifies the reference to a given Azure Key Vault.
    secretName String
    Name of the secret.
    secretVersion String
    The version of the secret to use. If left blank, the latest version of the secret is used.

    UserAssignedIdentityResponse

    ClientId string
    Client App Id associated with this identity.
    PrincipalId string
    Azure Active Directory principal ID associated with this Identity.
    ClientId string
    Client App Id associated with this identity.
    PrincipalId string
    Azure Active Directory principal ID associated with this Identity.
    clientId String
    Client App Id associated with this identity.
    principalId String
    Azure Active Directory principal ID associated with this Identity.
    clientId string
    Client App Id associated with this identity.
    principalId string
    Azure Active Directory principal ID associated with this Identity.
    client_id str
    Client App Id associated with this identity.
    principal_id str
    Azure Active Directory principal ID associated with this Identity.
    clientId String
    Client App Id associated with this identity.
    principalId String
    Azure Active Directory principal ID associated with this Identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi