extendedlocation

package
v5.89.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CustomLocation

type CustomLocation struct {
	pulumi.CustomResourceState

	// An `authentication` block as defined below.
	Authentication CustomLocationAuthenticationPtrOutput `pulumi:"authentication"`
	// Specifies the list of Cluster Extension IDs.
	ClusterExtensionIds pulumi.StringArrayOutput `pulumi:"clusterExtensionIds"`
	// Specifies the display name of the Custom Location.
	DisplayName pulumi.StringPtrOutput `pulumi:"displayName"`
	// Specifies the host resource ID.
	HostResourceId pulumi.StringOutput `pulumi:"hostResourceId"`
	// Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.
	HostType pulumi.StringPtrOutput `pulumi:"hostType"`
	// Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.
	Namespace pulumi.StringOutput `pulumi:"namespace"`
	// Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
}

Manages a Custom Location within an Extended Location.

> **Note:** Installing and configuring the Azure Arc Agent on your Kubernetes Cluster to establish connectivity is outside the scope of this document. For more details refer to [Deploy agents to your cluster](https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/conceptual-agent-overview#deploy-agents-to-your-cluster) and [Connect an existing Kubernetes Cluster](https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/quickstart-connect-cluster?tabs=azure-cli#connect-an-existing-kubernetes-cluster). If you encounter issues connecting your Kubernetes Cluster to Azure Arc, we'd recommend opening a ticket with Microsoft Support.

## Import

Custom Locations can be imported using the resource id, e.g.

```sh $ pulumi import azure:extendedlocation/customLocation:CustomLocation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ExtendedLocation/customLocations/example-custom-location ```

func GetCustomLocation

func GetCustomLocation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomLocationState, opts ...pulumi.ResourceOption) (*CustomLocation, error)

GetCustomLocation gets an existing CustomLocation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCustomLocation

func NewCustomLocation(ctx *pulumi.Context,
	name string, args *CustomLocationArgs, opts ...pulumi.ResourceOption) (*CustomLocation, error)

NewCustomLocation registers a new resource with the given unique name, arguments, and options.

func (*CustomLocation) ElementType

func (*CustomLocation) ElementType() reflect.Type

func (*CustomLocation) ToCustomLocationOutput

func (i *CustomLocation) ToCustomLocationOutput() CustomLocationOutput

func (*CustomLocation) ToCustomLocationOutputWithContext

func (i *CustomLocation) ToCustomLocationOutputWithContext(ctx context.Context) CustomLocationOutput

type CustomLocationArgs

type CustomLocationArgs struct {
	// An `authentication` block as defined below.
	Authentication CustomLocationAuthenticationPtrInput
	// Specifies the list of Cluster Extension IDs.
	ClusterExtensionIds pulumi.StringArrayInput
	// Specifies the display name of the Custom Location.
	DisplayName pulumi.StringPtrInput
	// Specifies the host resource ID.
	HostResourceId pulumi.StringInput
	// Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.
	HostType pulumi.StringPtrInput
	// Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	Location pulumi.StringPtrInput
	// Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.
	Name pulumi.StringPtrInput
	// Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.
	Namespace pulumi.StringInput
	// Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	ResourceGroupName pulumi.StringInput
}

The set of arguments for constructing a CustomLocation resource.

func (CustomLocationArgs) ElementType

func (CustomLocationArgs) ElementType() reflect.Type

type CustomLocationArray

type CustomLocationArray []CustomLocationInput

func (CustomLocationArray) ElementType

func (CustomLocationArray) ElementType() reflect.Type

func (CustomLocationArray) ToCustomLocationArrayOutput

func (i CustomLocationArray) ToCustomLocationArrayOutput() CustomLocationArrayOutput

func (CustomLocationArray) ToCustomLocationArrayOutputWithContext

func (i CustomLocationArray) ToCustomLocationArrayOutputWithContext(ctx context.Context) CustomLocationArrayOutput

type CustomLocationArrayInput

type CustomLocationArrayInput interface {
	pulumi.Input

	ToCustomLocationArrayOutput() CustomLocationArrayOutput
	ToCustomLocationArrayOutputWithContext(context.Context) CustomLocationArrayOutput
}

CustomLocationArrayInput is an input type that accepts CustomLocationArray and CustomLocationArrayOutput values. You can construct a concrete instance of `CustomLocationArrayInput` via:

CustomLocationArray{ CustomLocationArgs{...} }

type CustomLocationArrayOutput

type CustomLocationArrayOutput struct{ *pulumi.OutputState }

func (CustomLocationArrayOutput) ElementType

func (CustomLocationArrayOutput) ElementType() reflect.Type

func (CustomLocationArrayOutput) Index

func (CustomLocationArrayOutput) ToCustomLocationArrayOutput

func (o CustomLocationArrayOutput) ToCustomLocationArrayOutput() CustomLocationArrayOutput

func (CustomLocationArrayOutput) ToCustomLocationArrayOutputWithContext

func (o CustomLocationArrayOutput) ToCustomLocationArrayOutputWithContext(ctx context.Context) CustomLocationArrayOutput

type CustomLocationAuthentication

type CustomLocationAuthentication struct {
	// Specifies the type of authentication.
	Type *string `pulumi:"type"`
	// Specifies the value of authentication.
	Value string `pulumi:"value"`
}

type CustomLocationAuthenticationArgs

type CustomLocationAuthenticationArgs struct {
	// Specifies the type of authentication.
	Type pulumi.StringPtrInput `pulumi:"type"`
	// Specifies the value of authentication.
	Value pulumi.StringInput `pulumi:"value"`
}

func (CustomLocationAuthenticationArgs) ElementType

func (CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationOutput

func (i CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationOutput() CustomLocationAuthenticationOutput

func (CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationOutputWithContext

func (i CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationOutputWithContext(ctx context.Context) CustomLocationAuthenticationOutput

func (CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationPtrOutput

func (i CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationPtrOutput() CustomLocationAuthenticationPtrOutput

func (CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationPtrOutputWithContext

func (i CustomLocationAuthenticationArgs) ToCustomLocationAuthenticationPtrOutputWithContext(ctx context.Context) CustomLocationAuthenticationPtrOutput

type CustomLocationAuthenticationInput

type CustomLocationAuthenticationInput interface {
	pulumi.Input

	ToCustomLocationAuthenticationOutput() CustomLocationAuthenticationOutput
	ToCustomLocationAuthenticationOutputWithContext(context.Context) CustomLocationAuthenticationOutput
}

CustomLocationAuthenticationInput is an input type that accepts CustomLocationAuthenticationArgs and CustomLocationAuthenticationOutput values. You can construct a concrete instance of `CustomLocationAuthenticationInput` via:

CustomLocationAuthenticationArgs{...}

type CustomLocationAuthenticationOutput

type CustomLocationAuthenticationOutput struct{ *pulumi.OutputState }

func (CustomLocationAuthenticationOutput) ElementType

func (CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationOutput

func (o CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationOutput() CustomLocationAuthenticationOutput

func (CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationOutputWithContext

func (o CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationOutputWithContext(ctx context.Context) CustomLocationAuthenticationOutput

func (CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationPtrOutput

func (o CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationPtrOutput() CustomLocationAuthenticationPtrOutput

func (CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationPtrOutputWithContext

func (o CustomLocationAuthenticationOutput) ToCustomLocationAuthenticationPtrOutputWithContext(ctx context.Context) CustomLocationAuthenticationPtrOutput

func (CustomLocationAuthenticationOutput) Type

Specifies the type of authentication.

func (CustomLocationAuthenticationOutput) Value

Specifies the value of authentication.

type CustomLocationAuthenticationPtrInput

type CustomLocationAuthenticationPtrInput interface {
	pulumi.Input

	ToCustomLocationAuthenticationPtrOutput() CustomLocationAuthenticationPtrOutput
	ToCustomLocationAuthenticationPtrOutputWithContext(context.Context) CustomLocationAuthenticationPtrOutput
}

CustomLocationAuthenticationPtrInput is an input type that accepts CustomLocationAuthenticationArgs, CustomLocationAuthenticationPtr and CustomLocationAuthenticationPtrOutput values. You can construct a concrete instance of `CustomLocationAuthenticationPtrInput` via:

        CustomLocationAuthenticationArgs{...}

or:

        nil

type CustomLocationAuthenticationPtrOutput

type CustomLocationAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (CustomLocationAuthenticationPtrOutput) Elem

func (CustomLocationAuthenticationPtrOutput) ElementType

func (CustomLocationAuthenticationPtrOutput) ToCustomLocationAuthenticationPtrOutput

func (o CustomLocationAuthenticationPtrOutput) ToCustomLocationAuthenticationPtrOutput() CustomLocationAuthenticationPtrOutput

func (CustomLocationAuthenticationPtrOutput) ToCustomLocationAuthenticationPtrOutputWithContext

func (o CustomLocationAuthenticationPtrOutput) ToCustomLocationAuthenticationPtrOutputWithContext(ctx context.Context) CustomLocationAuthenticationPtrOutput

func (CustomLocationAuthenticationPtrOutput) Type

Specifies the type of authentication.

func (CustomLocationAuthenticationPtrOutput) Value

Specifies the value of authentication.

type CustomLocationInput

type CustomLocationInput interface {
	pulumi.Input

	ToCustomLocationOutput() CustomLocationOutput
	ToCustomLocationOutputWithContext(ctx context.Context) CustomLocationOutput
}

type CustomLocationMap

type CustomLocationMap map[string]CustomLocationInput

func (CustomLocationMap) ElementType

func (CustomLocationMap) ElementType() reflect.Type

func (CustomLocationMap) ToCustomLocationMapOutput

func (i CustomLocationMap) ToCustomLocationMapOutput() CustomLocationMapOutput

func (CustomLocationMap) ToCustomLocationMapOutputWithContext

func (i CustomLocationMap) ToCustomLocationMapOutputWithContext(ctx context.Context) CustomLocationMapOutput

type CustomLocationMapInput

type CustomLocationMapInput interface {
	pulumi.Input

	ToCustomLocationMapOutput() CustomLocationMapOutput
	ToCustomLocationMapOutputWithContext(context.Context) CustomLocationMapOutput
}

CustomLocationMapInput is an input type that accepts CustomLocationMap and CustomLocationMapOutput values. You can construct a concrete instance of `CustomLocationMapInput` via:

CustomLocationMap{ "key": CustomLocationArgs{...} }

type CustomLocationMapOutput

type CustomLocationMapOutput struct{ *pulumi.OutputState }

func (CustomLocationMapOutput) ElementType

func (CustomLocationMapOutput) ElementType() reflect.Type

func (CustomLocationMapOutput) MapIndex

func (CustomLocationMapOutput) ToCustomLocationMapOutput

func (o CustomLocationMapOutput) ToCustomLocationMapOutput() CustomLocationMapOutput

func (CustomLocationMapOutput) ToCustomLocationMapOutputWithContext

func (o CustomLocationMapOutput) ToCustomLocationMapOutputWithContext(ctx context.Context) CustomLocationMapOutput

type CustomLocationOutput

type CustomLocationOutput struct{ *pulumi.OutputState }

func (CustomLocationOutput) Authentication

An `authentication` block as defined below.

func (CustomLocationOutput) ClusterExtensionIds

func (o CustomLocationOutput) ClusterExtensionIds() pulumi.StringArrayOutput

Specifies the list of Cluster Extension IDs.

func (CustomLocationOutput) DisplayName

Specifies the display name of the Custom Location.

func (CustomLocationOutput) ElementType

func (CustomLocationOutput) ElementType() reflect.Type

func (CustomLocationOutput) HostResourceId

func (o CustomLocationOutput) HostResourceId() pulumi.StringOutput

Specifies the host resource ID.

func (CustomLocationOutput) HostType

Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.

func (CustomLocationOutput) Location

Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.

func (CustomLocationOutput) Name

Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.

func (CustomLocationOutput) Namespace

Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.

func (CustomLocationOutput) ResourceGroupName

func (o CustomLocationOutput) ResourceGroupName() pulumi.StringOutput

Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.

func (CustomLocationOutput) ToCustomLocationOutput

func (o CustomLocationOutput) ToCustomLocationOutput() CustomLocationOutput

func (CustomLocationOutput) ToCustomLocationOutputWithContext

func (o CustomLocationOutput) ToCustomLocationOutputWithContext(ctx context.Context) CustomLocationOutput

type CustomLocationState

type CustomLocationState struct {
	// An `authentication` block as defined below.
	Authentication CustomLocationAuthenticationPtrInput
	// Specifies the list of Cluster Extension IDs.
	ClusterExtensionIds pulumi.StringArrayInput
	// Specifies the display name of the Custom Location.
	DisplayName pulumi.StringPtrInput
	// Specifies the host resource ID.
	HostResourceId pulumi.StringPtrInput
	// Specifies the host type of the Custom Location. The only possible values is `KubernetesCluster`.
	HostType pulumi.StringPtrInput
	// Specifies the Azure location where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	Location pulumi.StringPtrInput
	// Specifies the name which should be used for this Custom Location. Changing this forces a new Custom Location to be created.
	Name pulumi.StringPtrInput
	// Specifies the namespace of the Custom Location. Changing this forces a new Custom Location to be created.
	Namespace pulumi.StringPtrInput
	// Specifies the name of the Resource Group where the Custom Location should exist. Changing this forces a new Custom Location to be created.
	ResourceGroupName pulumi.StringPtrInput
}

func (CustomLocationState) ElementType

func (CustomLocationState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL