Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

getAssignment

Security Assignment on a resource group over a given scope API Version: 2021-08-01-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_id: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAssignmentResult
def get_assignment_output(assignment_id: Optional[pulumi.Input[str]] = None,
                   resource_group_name: 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:security:getAssignment
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AssignmentId string

The security assignment key - unique key for the standard assignment

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

AssignmentId string

The security assignment key - unique key for the standard assignment

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

assignmentId String

The security assignment key - unique key for the standard assignment

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

assignmentId string

The security assignment key - unique key for the standard assignment

resourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

assignment_id str

The security assignment key - unique key for the standard assignment

resource_group_name str

The name of the resource group within the user's subscription. The name is case insensitive.

assignmentId String

The security assignment key - unique key for the standard assignment

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

getAssignment Result

The following output properties are available:

Id string

Resource Id

Name string

Resource name

SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

Resource type

AdditionalData Pulumi.AzureNative.Security.Outputs.AssignmentPropertiesResponseAdditionalData

Additional data about the assignment

AssignedComponent Pulumi.AzureNative.Security.Outputs.AssignedComponentItemResponse

Component item with key as applied to this standard assignment over the given scope

AssignedStandard Pulumi.AzureNative.Security.Outputs.AssignedStandardItemResponse

Standard item with key as applied to this standard assignment over the given scope

Description string

description of the standardAssignment

DisplayName string

display name of the standardAssignment

Effect string

expected effect of this assignment (Disable/Exempt/etc)

Etag string

Entity tag is used for comparing two or more entities from the same requested resource.

ExpiresOn string

Expiration date of this assignment as a full ISO date

Kind string

Kind of the resource

Location string

Location where the resource is stored

Metadata object

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

Scope string

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

Tags Dictionary<string, string>

A list of key value pairs that describe the resource.

Id string

Resource Id

Name string

Resource name

SystemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Type string

Resource type

AdditionalData AssignmentPropertiesResponseAdditionalData

Additional data about the assignment

AssignedComponent AssignedComponentItemResponse

Component item with key as applied to this standard assignment over the given scope

AssignedStandard AssignedStandardItemResponse

Standard item with key as applied to this standard assignment over the given scope

Description string

description of the standardAssignment

DisplayName string

display name of the standardAssignment

Effect string

expected effect of this assignment (Disable/Exempt/etc)

Etag string

Entity tag is used for comparing two or more entities from the same requested resource.

ExpiresOn string

Expiration date of this assignment as a full ISO date

Kind string

Kind of the resource

Location string

Location where the resource is stored

Metadata interface{}

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

Scope string

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

Tags map[string]string

A list of key value pairs that describe the resource.

id String

Resource Id

name String

Resource name

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

Resource type

additionalData AssignmentPropertiesResponseAdditionalData

Additional data about the assignment

assignedComponent AssignedComponentItemResponse

Component item with key as applied to this standard assignment over the given scope

assignedStandard AssignedStandardItemResponse

Standard item with key as applied to this standard assignment over the given scope

description String

description of the standardAssignment

displayName String

display name of the standardAssignment

effect String

expected effect of this assignment (Disable/Exempt/etc)

etag String

Entity tag is used for comparing two or more entities from the same requested resource.

expiresOn String

Expiration date of this assignment as a full ISO date

kind String

Kind of the resource

location String

Location where the resource is stored

metadata Object

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

scope String

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

tags Map<String,String>

A list of key value pairs that describe the resource.

id string

Resource Id

name string

Resource name

systemData SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type string

Resource type

additionalData AssignmentPropertiesResponseAdditionalData

Additional data about the assignment

assignedComponent AssignedComponentItemResponse

Component item with key as applied to this standard assignment over the given scope

assignedStandard AssignedStandardItemResponse

Standard item with key as applied to this standard assignment over the given scope

description string

description of the standardAssignment

displayName string

display name of the standardAssignment

effect string

expected effect of this assignment (Disable/Exempt/etc)

etag string

Entity tag is used for comparing two or more entities from the same requested resource.

expiresOn string

Expiration date of this assignment as a full ISO date

kind string

Kind of the resource

location string

Location where the resource is stored

metadata any

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

scope string

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

tags {[key: string]: string}

A list of key value pairs that describe the resource.

id str

Resource Id

name str

Resource name

system_data SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type str

Resource type

additional_data AssignmentPropertiesResponseAdditionalData

Additional data about the assignment

assigned_component AssignedComponentItemResponse

Component item with key as applied to this standard assignment over the given scope

assigned_standard AssignedStandardItemResponse

Standard item with key as applied to this standard assignment over the given scope

description str

description of the standardAssignment

display_name str

display name of the standardAssignment

effect str

expected effect of this assignment (Disable/Exempt/etc)

etag str

Entity tag is used for comparing two or more entities from the same requested resource.

expires_on str

Expiration date of this assignment as a full ISO date

kind str

Kind of the resource

location str

Location where the resource is stored

metadata Any

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

scope str

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

tags Mapping[str, str]

A list of key value pairs that describe the resource.

id String

Resource Id

name String

Resource name

systemData Property Map

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type String

Resource type

additionalData Property Map

Additional data about the assignment

assignedComponent Property Map

Component item with key as applied to this standard assignment over the given scope

assignedStandard Property Map

Standard item with key as applied to this standard assignment over the given scope

description String

description of the standardAssignment

displayName String

display name of the standardAssignment

effect String

expected effect of this assignment (Disable/Exempt/etc)

etag String

Entity tag is used for comparing two or more entities from the same requested resource.

expiresOn String

Expiration date of this assignment as a full ISO date

kind String

Kind of the resource

location String

Location where the resource is stored

metadata Any

The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

scope String

Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription

tags Map<String>

A list of key value pairs that describe the resource.

Supporting Types

AssignedComponentItemResponse

Key string

unique key to a security assessment object

Key string

unique key to a security assessment object

key String

unique key to a security assessment object

key string

unique key to a security assessment object

key str

unique key to a security assessment object

key String

unique key to a security assessment object

AssignedStandardItemResponse

Id string

full resourceId of the Microsoft.Security/standard object

Id string

full resourceId of the Microsoft.Security/standard object

id String

full resourceId of the Microsoft.Security/standard object

id string

full resourceId of the Microsoft.Security/standard object

id str

full resourceId of the Microsoft.Security/standard object

id String

full resourceId of the Microsoft.Security/standard object

AssignmentPropertiesResponseAdditionalData

ExemptionCategory string

Exemption category of this assignment

ExemptionCategory string

Exemption category of this assignment

exemptionCategory String

Exemption category of this assignment

exemptionCategory string

Exemption category of this assignment

exemption_category str

Exemption category of this assignment

exemptionCategory String

Exemption category of this assignment

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

The type of identity that last modified the resource.

created_at str

The timestamp of resource creation (UTC).

created_by str

The identity that created the resource.

created_by_type str

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0