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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
azure-native.blueprint.getAssignment
Explore with Pulumi AI
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.66.0 published on Wednesday, Oct 9, 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:
- Assignment
Name string - Name of the blueprint assignment.
- Resource
Scope string - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- Assignment
Name string - Name of the blueprint assignment.
- Resource
Scope string - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- assignment
Name String - Name of the blueprint assignment.
- resource
Scope String - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- assignment
Name string - Name of the blueprint assignment.
- resource
Scope 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}').
- assignment
Name String - Name of the blueprint assignment.
- resource
Scope 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.
Azure Native. Blueprint. Outputs. Managed Service Identity Response - Managed identity for this blueprint assignment.
- Location string
- The location of this blueprint assignment.
- Name string
- Name of this resource.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Blueprint. Outputs. Parameter Value Response> - Blueprint assignment parameter values.
- Provisioning
State string - State of the blueprint assignment.
- Resource
Groups Dictionary<string, Pulumi.Azure Native. Blueprint. Outputs. Resource Group Value Response> - Names and locations of resource group placeholders.
- Status
Pulumi.
Azure Native. Blueprint. Outputs. Assignment Status Response - Status of blueprint assignment. This field is readonly.
- Type string
- Type of this resource.
- Blueprint
Id string - ID of the published version of a blueprint definition.
- Description string
- Multi-line explain this resource.
- Display
Name string - One-liner string explain this resource.
- Locks
Pulumi.
Azure Native. Blueprint. Outputs. Assignment Lock Settings Response - 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
Managed
Service Identity Response - Managed identity for this blueprint assignment.
- Location string
- The location of this blueprint assignment.
- Name string
- Name of this resource.
- Parameters
map[string]Parameter
Value Response - Blueprint assignment parameter values.
- Provisioning
State string - State of the blueprint assignment.
- Resource
Groups map[string]ResourceGroup Value Response - Names and locations of resource group placeholders.
- Status
Assignment
Status Response - Status of blueprint assignment. This field is readonly.
- Type string
- Type of this resource.
- Blueprint
Id string - ID of the published version of a blueprint definition.
- Description string
- Multi-line explain this resource.
- Display
Name string - One-liner string explain this resource.
- Locks
Assignment
Lock Settings Response - 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
Managed
Service Identity Response - Managed identity for this blueprint assignment.
- location String
- The location of this blueprint assignment.
- name String
- Name of this resource.
- parameters
Map<String,Parameter
Value Response> - Blueprint assignment parameter values.
- provisioning
State String - State of the blueprint assignment.
- resource
Groups Map<String,ResourceGroup Value Response> - Names and locations of resource group placeholders.
- status
Assignment
Status Response - Status of blueprint assignment. This field is readonly.
- type String
- Type of this resource.
- blueprint
Id String - ID of the published version of a blueprint definition.
- description String
- Multi-line explain this resource.
- display
Name String - One-liner string explain this resource.
- locks
Assignment
Lock Settings Response - 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
Managed
Service Identity Response - Managed identity for this blueprint assignment.
- location string
- The location of this blueprint assignment.
- name string
- Name of this resource.
- parameters
{[key: string]: Parameter
Value Response} - Blueprint assignment parameter values.
- provisioning
State string - State of the blueprint assignment.
- resource
Groups {[key: string]: ResourceGroup Value Response} - Names and locations of resource group placeholders.
- status
Assignment
Status Response - Status of blueprint assignment. This field is readonly.
- type string
- Type of this resource.
- blueprint
Id string - ID of the published version of a blueprint definition.
- description string
- Multi-line explain this resource.
- display
Name string - One-liner string explain this resource.
- locks
Assignment
Lock Settings Response - 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
Managed
Service Identity Response - Managed identity for this blueprint assignment.
- location str
- The location of this blueprint assignment.
- name str
- Name of this resource.
- parameters
Mapping[str, Parameter
Value Response] - Blueprint assignment parameter values.
- provisioning_
state str - State of the blueprint assignment.
- resource_
groups Mapping[str, ResourceGroup Value Response] - Names and locations of resource group placeholders.
- status
Assignment
Status Response - 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
Assignment
Lock Settings Response - 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.
- provisioning
State String - State of the blueprint assignment.
- resource
Groups 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.
- blueprint
Id String - ID of the published version of a blueprint definition.
- description String
- Multi-line explain this resource.
- display
Name 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
- Excluded
Actions 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.
- Excluded
Principals List<string> - List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
- Mode string
- Lock mode.
- Excluded
Actions []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.
- Excluded
Principals []string - List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
- Mode string
- Lock mode.
- excluded
Actions 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.
- excluded
Principals List<String> - List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
- mode String
- Lock mode.
- excluded
Actions 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.
- excluded
Principals 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.
- excluded
Actions 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.
- excluded
Principals List<String> - List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted.
- mode String
- Lock mode.
AssignmentStatusResponse
- Last
Modified string - Last modified time of this blueprint definition.
- Managed
Resources List<string> - List of resources that were created by the blueprint assignment.
- Time
Created string - Creation time of this blueprint definition.
- Last
Modified string - Last modified time of this blueprint definition.
- Managed
Resources []string - List of resources that were created by the blueprint assignment.
- Time
Created string - Creation time of this blueprint definition.
- last
Modified String - Last modified time of this blueprint definition.
- managed
Resources List<String> - List of resources that were created by the blueprint assignment.
- time
Created String - Creation time of this blueprint definition.
- last
Modified string - Last modified time of this blueprint definition.
- managed
Resources string[] - List of resources that were created by the blueprint assignment.
- time
Created 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.
- last
Modified String - Last modified time of this blueprint definition.
- managed
Resources List<String> - List of resources that were created by the blueprint assignment.
- time
Created 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.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- Tenant
Id string - ID of the Azure Active Directory.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Blueprint. Inputs. User Assigned Identity Response> - 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.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- Tenant
Id string - ID of the Azure Active Directory.
- User
Assigned map[string]UserIdentities Assigned Identity Response - 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.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
- tenant
Id String - ID of the Azure Active Directory.
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - 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.
- principal
Id string - Azure Active Directory principal ID associated with this Identity.
- tenant
Id string - ID of the Azure Active Directory.
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - 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_ Mapping[str, Useridentities Assigned Identity Response] - 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.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
- tenant
Id String - ID of the Azure Active Directory.
- user
Assigned Map<Property Map>Identities - The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
ParameterValueResponse
- Reference
Pulumi.
Azure Native. Blueprint. Inputs. Secret Value Reference Response - Parameter value as reference type.
- Value object
- Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
- Reference
Secret
Value Reference Response - Parameter value as reference type.
- Value interface{}
- Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
- reference
Secret
Value Reference Response - Parameter value as reference type.
- value Object
- Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
- reference
Secret
Value Reference Response - Parameter value as reference type.
- value any
- Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans.
- reference
Secret
Value Reference Response - 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
SecretValueReferenceResponse
- Key
Vault Pulumi.Azure Native. Blueprint. Inputs. Key Vault Reference Response - Specifies the reference to a given Azure Key Vault.
- Secret
Name string - Name of the secret.
- Secret
Version string - The version of the secret to use. If left blank, the latest version of the secret is used.
- Key
Vault KeyVault Reference Response - Specifies the reference to a given Azure Key Vault.
- Secret
Name string - Name of the secret.
- Secret
Version string - The version of the secret to use. If left blank, the latest version of the secret is used.
- key
Vault KeyVault Reference Response - Specifies the reference to a given Azure Key Vault.
- secret
Name String - Name of the secret.
- secret
Version String - The version of the secret to use. If left blank, the latest version of the secret is used.
- key
Vault KeyVault Reference Response - Specifies the reference to a given Azure Key Vault.
- secret
Name string - Name of the secret.
- secret
Version string - The version of the secret to use. If left blank, the latest version of the secret is used.
- key_
vault KeyVault Reference Response - 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.
- key
Vault Property Map - Specifies the reference to a given Azure Key Vault.
- secret
Name String - Name of the secret.
- secret
Version String - The version of the secret to use. If left blank, the latest version of the secret is used.
UserAssignedIdentityResponse
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
- client
Id string - Client App Id associated with this identity.
- principal
Id 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.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi