1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. ApplicationKnownClients
Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi

azuread.ApplicationKnownClients

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi

    Import

    Application Known Clients can be imported using the object ID of the application in the following format.

    $ pulumi import azuread:index/applicationKnownClients:ApplicationKnownClients example /applications/00000000-0000-0000-0000-000000000000/knownClients
    

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureAD = Pulumi.AzureAD;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureAD.ApplicationRegistration("example", new()
        {
            DisplayName = "example",
        });
    
        var client = new AzureAD.ApplicationRegistration("client", new()
        {
            DisplayName = "example client",
        });
    
        var exampleApplicationKnownClients = new AzureAD.ApplicationKnownClients("example", new()
        {
            ApplicationId = example.Id,
            KnownClientIds = new[]
            {
                client.ClientId,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := azuread.NewApplicationRegistration(ctx, "example", &azuread.ApplicationRegistrationArgs{
    			DisplayName: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		client, err := azuread.NewApplicationRegistration(ctx, "client", &azuread.ApplicationRegistrationArgs{
    			DisplayName: pulumi.String("example client"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuread.NewApplicationKnownClients(ctx, "example", &azuread.ApplicationKnownClientsArgs{
    			ApplicationId: example.ID(),
    			KnownClientIds: pulumi.StringArray{
    				client.ClientId,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azuread.ApplicationRegistration;
    import com.pulumi.azuread.ApplicationRegistrationArgs;
    import com.pulumi.azuread.ApplicationKnownClients;
    import com.pulumi.azuread.ApplicationKnownClientsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ApplicationRegistration("example", ApplicationRegistrationArgs.builder()        
                .displayName("example")
                .build());
    
            var client = new ApplicationRegistration("client", ApplicationRegistrationArgs.builder()        
                .displayName("example client")
                .build());
    
            var exampleApplicationKnownClients = new ApplicationKnownClients("exampleApplicationKnownClients", ApplicationKnownClientsArgs.builder()        
                .applicationId(example.id())
                .knownClientIds(client.clientId())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azuread as azuread
    
    example = azuread.ApplicationRegistration("example", display_name="example")
    client = azuread.ApplicationRegistration("client", display_name="example client")
    example_application_known_clients = azuread.ApplicationKnownClients("example",
        application_id=example.id,
        known_client_ids=[client.client_id])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azuread from "@pulumi/azuread";
    
    const example = new azuread.ApplicationRegistration("example", {displayName: "example"});
    const client = new azuread.ApplicationRegistration("client", {displayName: "example client"});
    const exampleApplicationKnownClients = new azuread.ApplicationKnownClients("example", {
        applicationId: example.id,
        knownClientIds: [client.clientId],
    });
    
    resources:
      example:
        type: azuread:ApplicationRegistration
        properties:
          displayName: example
      client:
        type: azuread:ApplicationRegistration
        properties:
          displayName: example client
      exampleApplicationKnownClients:
        type: azuread:ApplicationKnownClients
        name: example
        properties:
          applicationId: ${example.id}
          knownClientIds:
            - ${client.clientId}
    

    Create ApplicationKnownClients Resource

    new ApplicationKnownClients(name: string, args: ApplicationKnownClientsArgs, opts?: CustomResourceOptions);
    @overload
    def ApplicationKnownClients(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                application_id: Optional[str] = None,
                                known_client_ids: Optional[Sequence[str]] = None)
    @overload
    def ApplicationKnownClients(resource_name: str,
                                args: ApplicationKnownClientsArgs,
                                opts: Optional[ResourceOptions] = None)
    func NewApplicationKnownClients(ctx *Context, name string, args ApplicationKnownClientsArgs, opts ...ResourceOption) (*ApplicationKnownClients, error)
    public ApplicationKnownClients(string name, ApplicationKnownClientsArgs args, CustomResourceOptions? opts = null)
    public ApplicationKnownClients(String name, ApplicationKnownClientsArgs args)
    public ApplicationKnownClients(String name, ApplicationKnownClientsArgs args, CustomResourceOptions options)
    
    type: azuread:ApplicationKnownClients
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ApplicationKnownClientsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApplicationKnownClientsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApplicationKnownClientsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationKnownClientsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationKnownClientsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ApplicationKnownClients Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApplicationKnownClients resource accepts the following input properties:

    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    KnownClientIds List<string>
    A set of client IDs for the known applications.
    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    KnownClientIds []string
    A set of client IDs for the known applications.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds List<String>
    A set of client IDs for the known applications.
    applicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds string[]
    A set of client IDs for the known applications.
    application_id str
    The resource ID of the application registration. Changing this forces a new resource to be created.
    known_client_ids Sequence[str]
    A set of client IDs for the known applications.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds List<String>
    A set of client IDs for the known applications.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationKnownClients resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApplicationKnownClients Resource

    Get an existing ApplicationKnownClients resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApplicationKnownClientsState, opts?: CustomResourceOptions): ApplicationKnownClients
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            known_client_ids: Optional[Sequence[str]] = None) -> ApplicationKnownClients
    func GetApplicationKnownClients(ctx *Context, name string, id IDInput, state *ApplicationKnownClientsState, opts ...ResourceOption) (*ApplicationKnownClients, error)
    public static ApplicationKnownClients Get(string name, Input<string> id, ApplicationKnownClientsState? state, CustomResourceOptions? opts = null)
    public static ApplicationKnownClients get(String name, Output<String> id, ApplicationKnownClientsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    KnownClientIds List<string>
    A set of client IDs for the known applications.
    ApplicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    KnownClientIds []string
    A set of client IDs for the known applications.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds List<String>
    A set of client IDs for the known applications.
    applicationId string
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds string[]
    A set of client IDs for the known applications.
    application_id str
    The resource ID of the application registration. Changing this forces a new resource to be created.
    known_client_ids Sequence[str]
    A set of client IDs for the known applications.
    applicationId String
    The resource ID of the application registration. Changing this forces a new resource to be created.
    knownClientIds List<String>
    A set of client IDs for the known applications.

    Package Details

    Repository
    Azure Active Directory (Azure AD) pulumi/pulumi-azuread
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuread Terraform Provider.
    azuread logo
    Azure Active Directory (Azure AD) v5.47.2 published on Tuesday, Feb 27, 2024 by Pulumi