1. Docs
  2. Reference
  3. API
  4. Azure
  5. devspace
  6. Controller

Controller

Manages a DevSpace Controller.

NOTE: Microsoft will be retiring Azure Dev Spaces on 31 October 2023, please see the product documentation for more information.

!> NOTE: The Azure API no longer allows provisioning new DevSpace Controllers - as such this resource exists only to allow existing users to continue managing these in the provider at this time.

Create a Controller Resource

new Controller(name: string, args: ControllerArgs, opts?: CustomResourceOptions);
@overload
def Controller(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               sku_name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               target_container_host_credentials_base64: Optional[str] = None,
               target_container_host_resource_id: Optional[str] = None)
@overload
def Controller(resource_name: str,
               args: ControllerArgs,
               opts: Optional[ResourceOptions] = None)
func NewController(ctx *Context, name string, args ControllerArgs, opts ...ResourceOption) (*Controller, error)
public Controller(string name, ControllerArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ControllerArgs
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 ControllerArgs
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 ControllerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ControllerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Controller Resource Properties

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

Inputs

The Controller resource accepts the following input properties:

ResourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
SkuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
TargetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
TargetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
Location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
Name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
SkuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
TargetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
TargetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
Location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
Name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
skuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
targetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
targetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name str
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
sku_name str
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
target_container_host_credentials_base64 str
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
target_container_host_resource_id str
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
location str
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
name str
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.

Outputs

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

DataPlaneFqdn string
DNS name for accessing DataPlane services.
HostSuffix string
The host suffix for the DevSpace Controller.
Id string
The provider-assigned unique ID for this managed resource.
DataPlaneFqdn string
DNS name for accessing DataPlane services.
HostSuffix string
The host suffix for the DevSpace Controller.
Id string
The provider-assigned unique ID for this managed resource.
dataPlaneFqdn string
DNS name for accessing DataPlane services.
hostSuffix string
The host suffix for the DevSpace Controller.
id string
The provider-assigned unique ID for this managed resource.
data_plane_fqdn str
DNS name for accessing DataPlane services.
host_suffix str
The host suffix for the DevSpace Controller.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Controller Resource

Get an existing Controller 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?: ControllerState, opts?: CustomResourceOptions): Controller
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_plane_fqdn: Optional[str] = None,
        host_suffix: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        target_container_host_credentials_base64: Optional[str] = None,
        target_container_host_resource_id: Optional[str] = None) -> Controller
func GetController(ctx *Context, name string, id IDInput, state *ControllerState, opts ...ResourceOption) (*Controller, error)
public static Controller Get(string name, Input<string> id, ControllerState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

DataPlaneFqdn string
DNS name for accessing DataPlane services.
HostSuffix string
The host suffix for the DevSpace Controller.
Location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
Name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
ResourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
SkuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TargetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
TargetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
DataPlaneFqdn string
DNS name for accessing DataPlane services.
HostSuffix string
The host suffix for the DevSpace Controller.
Location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
Name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
ResourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
SkuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
Tags map[string]string
A mapping of tags to assign to the resource.
TargetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
TargetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
dataPlaneFqdn string
DNS name for accessing DataPlane services.
hostSuffix string
The host suffix for the DevSpace Controller.
location string
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
name string
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
resourceGroupName string
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
skuName string
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
targetContainerHostCredentialsBase64 string
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
targetContainerHostResourceId string
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
data_plane_fqdn str
DNS name for accessing DataPlane services.
host_suffix str
The host suffix for the DevSpace Controller.
location str
Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.
name str
Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.
resource_group_name str
The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.
sku_name str
Specifies the SKU Name for this DevSpace Controller. Possible values are S1.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
target_container_host_credentials_base64 str
Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.
target_container_host_resource_id str
The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.

Import

DevSpace Controller’s can be imported using the resource id, e.g.

 $ pulumi import azure:devspace/controller:Controller controller1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DevSpaces/controllers/controller1Name

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.
Register Now For PulumiUP