AzureClient class

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:

Multicloud overview

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")

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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 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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

AzureClient(String name, {AzureClientArgs? args, CustomResourceOptions? options}): Creates a new AzureClient. name The Pulumi resource name. args Arguments used to configure this AzureClient. The set of arguments for AzureClient. options Resource options controlling this resource's behavior.
AzureClient.reference(String urn): Creates a typed reference to an existing AzureClient resource.

Properties

applicationId ↔ Output<String>: The Azure Active Directory Application ID.
latefinal
certificate ↔ Output<String>: Output only. The PEM encoded x509 certificate.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Output only. The time at which this resource was created.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The location for the resource
latefinal
name ↔ Output<String>: The name of this resource.
latefinal
project ↔ Output<String>: The project for the resource
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
tenantId ↔ Output<String>: The Azure Active Directory Tenant ID.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>: Output only. A globally unique identifier for the client.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AzureClientState? state, CustomResourceOptions? options}) → AzureClient: Gets an existing AzureClient resource's state with the given name and id.