1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. container
  5. AzureClient
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.container.AzureClient

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    AzureClient resources hold client authentication information needed by the Anthos Multi-Cloud API to manage Azure resources on your Azure subscription.When an AzureCluster is created, an AzureClient resource needs to be provided and all operations on Azure resources associated to that cluster will authenticate to Azure services using the given client.AzureClient resources are immutable and cannot be modified upon creation.Each AzureClient resource is bound to a single Azure Active Directory Application and tenant.

    For more information, see:

    Example Usage

    Basic_azure_client

    A basic example of a containerazure azure client

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.container.AzureClient("primary", {
        applicationId: "12345678-1234-1234-1234-123456789111",
        location: "us-west1",
        name: "client-name",
        tenantId: "12345678-1234-1234-1234-123456789111",
        project: "my-project-name",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.container.AzureClient("primary",
        application_id="12345678-1234-1234-1234-123456789111",
        location="us-west1",
        name="client-name",
        tenant_id="12345678-1234-1234-1234-123456789111",
        project="my-project-name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/container"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := container.NewAzureClient(ctx, "primary", &container.AzureClientArgs{
    			ApplicationId: pulumi.String("12345678-1234-1234-1234-123456789111"),
    			Location:      pulumi.String("us-west1"),
    			Name:          pulumi.String("client-name"),
    			TenantId:      pulumi.String("12345678-1234-1234-1234-123456789111"),
    			Project:       pulumi.String("my-project-name"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var primary = new Gcp.Container.AzureClient("primary", new()
        {
            ApplicationId = "12345678-1234-1234-1234-123456789111",
            Location = "us-west1",
            Name = "client-name",
            TenantId = "12345678-1234-1234-1234-123456789111",
            Project = "my-project-name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.container.AzureClient;
    import com.pulumi.gcp.container.AzureClientArgs;
    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 primary = new AzureClient("primary", AzureClientArgs.builder()        
                .applicationId("12345678-1234-1234-1234-123456789111")
                .location("us-west1")
                .name("client-name")
                .tenantId("12345678-1234-1234-1234-123456789111")
                .project("my-project-name")
                .build());
    
        }
    }
    
    resources:
      primary:
        type: gcp:container:AzureClient
        properties:
          applicationId: 12345678-1234-1234-1234-123456789111
          location: us-west1
          name: client-name
          tenantId: 12345678-1234-1234-1234-123456789111
          project: my-project-name
    

    Create AzureClient Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AzureClient(name: string, args: AzureClientArgs, opts?: CustomResourceOptions);
    @overload
    def AzureClient(resource_name: str,
                    args: AzureClientArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AzureClient(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    application_id: Optional[str] = None,
                    location: Optional[str] = None,
                    tenant_id: Optional[str] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None)
    func NewAzureClient(ctx *Context, name string, args AzureClientArgs, opts ...ResourceOption) (*AzureClient, error)
    public AzureClient(string name, AzureClientArgs args, CustomResourceOptions? opts = null)
    public AzureClient(String name, AzureClientArgs args)
    public AzureClient(String name, AzureClientArgs args, CustomResourceOptions options)
    
    type: gcp:container:AzureClient
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AzureClientArgs
    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 AzureClientArgs
    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 AzureClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureClientArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azureClientResource = new Gcp.Container.AzureClient("azureClientResource", new()
    {
        ApplicationId = "string",
        Location = "string",
        TenantId = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := container.NewAzureClient(ctx, "azureClientResource", &container.AzureClientArgs{
    	ApplicationId: pulumi.String("string"),
    	Location:      pulumi.String("string"),
    	TenantId:      pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Project:       pulumi.String("string"),
    })
    
    var azureClientResource = new AzureClient("azureClientResource", AzureClientArgs.builder()        
        .applicationId("string")
        .location("string")
        .tenantId("string")
        .name("string")
        .project("string")
        .build());
    
    azure_client_resource = gcp.container.AzureClient("azureClientResource",
        application_id="string",
        location="string",
        tenant_id="string",
        name="string",
        project="string")
    
    const azureClientResource = new gcp.container.AzureClient("azureClientResource", {
        applicationId: "string",
        location: "string",
        tenantId: "string",
        name: "string",
        project: "string",
    });
    
    type: gcp:container:AzureClient
    properties:
        applicationId: string
        location: string
        name: string
        project: string
        tenantId: string
    

    AzureClient 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 AzureClient resource accepts the following input properties:

    ApplicationId string
    The Azure Active Directory Application ID.
    Location string
    The location for the resource
    TenantId string
    The Azure Active Directory Tenant ID.


    Name string
    The name of this resource.
    Project string
    The project for the resource
    ApplicationId string
    The Azure Active Directory Application ID.
    Location string
    The location for the resource
    TenantId string
    The Azure Active Directory Tenant ID.


    Name string
    The name of this resource.
    Project string
    The project for the resource
    applicationId String
    The Azure Active Directory Application ID.
    location String
    The location for the resource
    tenantId String
    The Azure Active Directory Tenant ID.


    name String
    The name of this resource.
    project String
    The project for the resource
    applicationId string
    The Azure Active Directory Application ID.
    location string
    The location for the resource
    tenantId string
    The Azure Active Directory Tenant ID.


    name string
    The name of this resource.
    project string
    The project for the resource
    application_id str
    The Azure Active Directory Application ID.
    location str
    The location for the resource
    tenant_id str
    The Azure Active Directory Tenant ID.


    name str
    The name of this resource.
    project str
    The project for the resource
    applicationId String
    The Azure Active Directory Application ID.
    location String
    The location for the resource
    tenantId String
    The Azure Active Directory Tenant ID.


    name String
    The name of this resource.
    project String
    The project for the resource

    Outputs

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

    Certificate string
    Output only. The PEM encoded x509 certificate.
    CreateTime string
    Output only. The time at which this resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uid string
    Output only. A globally unique identifier for the client.
    Certificate string
    Output only. The PEM encoded x509 certificate.
    CreateTime string
    Output only. The time at which this resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uid string
    Output only. A globally unique identifier for the client.
    certificate String
    Output only. The PEM encoded x509 certificate.
    createTime String
    Output only. The time at which this resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    uid String
    Output only. A globally unique identifier for the client.
    certificate string
    Output only. The PEM encoded x509 certificate.
    createTime string
    Output only. The time at which this resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    uid string
    Output only. A globally unique identifier for the client.
    certificate str
    Output only. The PEM encoded x509 certificate.
    create_time str
    Output only. The time at which this resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    uid str
    Output only. A globally unique identifier for the client.
    certificate String
    Output only. The PEM encoded x509 certificate.
    createTime String
    Output only. The time at which this resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    uid String
    Output only. A globally unique identifier for the client.

    Look up Existing AzureClient Resource

    Get an existing AzureClient 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?: AzureClientState, opts?: CustomResourceOptions): AzureClient
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            certificate: Optional[str] = None,
            create_time: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            tenant_id: Optional[str] = None,
            uid: Optional[str] = None) -> AzureClient
    func GetAzureClient(ctx *Context, name string, id IDInput, state *AzureClientState, opts ...ResourceOption) (*AzureClient, error)
    public static AzureClient Get(string name, Input<string> id, AzureClientState? state, CustomResourceOptions? opts = null)
    public static AzureClient get(String name, Output<String> id, AzureClientState 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 Azure Active Directory Application ID.
    Certificate string
    Output only. The PEM encoded x509 certificate.
    CreateTime string
    Output only. The time at which this resource was created.
    Location string
    The location for the resource
    Name string
    The name of this resource.
    Project string
    The project for the resource
    TenantId string
    The Azure Active Directory Tenant ID.


    Uid string
    Output only. A globally unique identifier for the client.
    ApplicationId string
    The Azure Active Directory Application ID.
    Certificate string
    Output only. The PEM encoded x509 certificate.
    CreateTime string
    Output only. The time at which this resource was created.
    Location string
    The location for the resource
    Name string
    The name of this resource.
    Project string
    The project for the resource
    TenantId string
    The Azure Active Directory Tenant ID.


    Uid string
    Output only. A globally unique identifier for the client.
    applicationId String
    The Azure Active Directory Application ID.
    certificate String
    Output only. The PEM encoded x509 certificate.
    createTime String
    Output only. The time at which this resource was created.
    location String
    The location for the resource
    name String
    The name of this resource.
    project String
    The project for the resource
    tenantId String
    The Azure Active Directory Tenant ID.


    uid String
    Output only. A globally unique identifier for the client.
    applicationId string
    The Azure Active Directory Application ID.
    certificate string
    Output only. The PEM encoded x509 certificate.
    createTime string
    Output only. The time at which this resource was created.
    location string
    The location for the resource
    name string
    The name of this resource.
    project string
    The project for the resource
    tenantId string
    The Azure Active Directory Tenant ID.


    uid string
    Output only. A globally unique identifier for the client.
    application_id str
    The Azure Active Directory Application ID.
    certificate str
    Output only. The PEM encoded x509 certificate.
    create_time str
    Output only. The time at which this resource was created.
    location str
    The location for the resource
    name str
    The name of this resource.
    project str
    The project for the resource
    tenant_id str
    The Azure Active Directory Tenant ID.


    uid str
    Output only. A globally unique identifier for the client.
    applicationId String
    The Azure Active Directory Application ID.
    certificate String
    Output only. The PEM encoded x509 certificate.
    createTime String
    Output only. The time at which this resource was created.
    location String
    The location for the resource
    name String
    The name of this resource.
    project String
    The project for the resource
    tenantId String
    The Azure Active Directory Tenant ID.


    uid String
    Output only. A globally unique identifier for the client.

    Import

    Client can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/azureClients/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

    When using the pulumi import command, Client can be imported using one of the formats above. For example:

    $ pulumi import gcp:container/azureClient:AzureClient default projects/{{project}}/locations/{{location}}/azureClients/{{name}}
    
    $ pulumi import gcp:container/azureClient:AzureClient default {{project}}/{{location}}/{{name}}
    
    $ pulumi import gcp:container/azureClient:AzureClient default {{location}}/{{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi