Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. UserApiKey

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

equinix-metal.UserApiKey

Explore with Pulumi AI

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new EquinixMetal.UserApiKey("test", new EquinixMetal.UserApiKeyArgs
        {
            Description = "Read-only user key",
            ReadOnly = true,
        });
    }

}
Copy
package main

import (
	"github.com/pulumi/pulumi-equinix-metal/sdk/v3/go/equinix-metal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := equinix - metal.NewUserApiKey(ctx, "test", &equinix-metal.UserApiKeyArgs{
			Description: pulumi.String("Read-only user key"),
			ReadOnly:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as metal from "@pulumi/metal";

const test = new metal.UserApiKey("test", {
    description: "Read-only user key",
    readOnly: true,
});
Copy
import pulumi
import pulumi_equinix_metal as equinix_metal

test = equinix_metal.UserApiKey("test",
    description="Read-only user key",
    read_only=True)
Copy

Coming soon!

Create UserApiKey Resource

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

Constructor syntax

new UserApiKey(name: string, args: UserApiKeyArgs, opts?: CustomResourceOptions);
@overload
def UserApiKey(resource_name: str,
               args: UserApiKeyArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def UserApiKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               read_only: Optional[bool] = None)
func NewUserApiKey(ctx *Context, name string, args UserApiKeyArgs, opts ...ResourceOption) (*UserApiKey, error)
public UserApiKey(string name, UserApiKeyArgs args, CustomResourceOptions? opts = null)
public UserApiKey(String name, UserApiKeyArgs args)
public UserApiKey(String name, UserApiKeyArgs args, CustomResourceOptions options)

type: equinix-metal:UserApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserApiKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserApiKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var userApiKeyResource = new EquinixMetal.UserApiKey("userApiKeyResource", new()
{
    Description = "string",
    ReadOnly = false,
});
Copy
example, err := equinixmetal.NewUserApiKey(ctx, "userApiKeyResource", &equinixmetal.UserApiKeyArgs{
	Description: pulumi.String("string"),
	ReadOnly:    pulumi.Bool(false),
})
Copy
var userApiKeyResource = new UserApiKey("userApiKeyResource", UserApiKeyArgs.builder()
    .description("string")
    .readOnly(false)
    .build());
Copy
user_api_key_resource = equinix_metal.UserApiKey("userApiKeyResource",
    description="string",
    read_only=False)
Copy
const userApiKeyResource = new equinix_metal.UserApiKey("userApiKeyResource", {
    description: "string",
    readOnly: false,
});
Copy
type: equinix-metal:UserApiKey
properties:
    description: string
    readOnly: false
Copy

UserApiKey Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserApiKey resource accepts the following input properties:

Description This property is required. string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
ReadOnly This property is required. bool
Flag indicating whether the API key shoud be read-only
Description This property is required. string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
ReadOnly This property is required. bool
Flag indicating whether the API key shoud be read-only
description This property is required. String
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly This property is required. Boolean
Flag indicating whether the API key shoud be read-only
description This property is required. string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly This property is required. boolean
Flag indicating whether the API key shoud be read-only
description This property is required. str
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
read_only This property is required. bool
Flag indicating whether the API key shoud be read-only
description This property is required. String
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly This property is required. Boolean
Flag indicating whether the API key shoud be read-only

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Token string
API token which can be used in Equinix Metal API clients
UserId string
UUID of the owner of the API key
Id string
The provider-assigned unique ID for this managed resource.
Token string
API token which can be used in Equinix Metal API clients
UserId string
UUID of the owner of the API key
id String
The provider-assigned unique ID for this managed resource.
token String
API token which can be used in Equinix Metal API clients
userId String
UUID of the owner of the API key
id string
The provider-assigned unique ID for this managed resource.
token string
API token which can be used in Equinix Metal API clients
userId string
UUID of the owner of the API key
id str
The provider-assigned unique ID for this managed resource.
token str
API token which can be used in Equinix Metal API clients
user_id str
UUID of the owner of the API key
id String
The provider-assigned unique ID for this managed resource.
token String
API token which can be used in Equinix Metal API clients
userId String
UUID of the owner of the API key

Look up Existing UserApiKey Resource

Get an existing UserApiKey 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?: UserApiKeyState, opts?: CustomResourceOptions): UserApiKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        read_only: Optional[bool] = None,
        token: Optional[str] = None,
        user_id: Optional[str] = None) -> UserApiKey
func GetUserApiKey(ctx *Context, name string, id IDInput, state *UserApiKeyState, opts ...ResourceOption) (*UserApiKey, error)
public static UserApiKey Get(string name, Input<string> id, UserApiKeyState? state, CustomResourceOptions? opts = null)
public static UserApiKey get(String name, Output<String> id, UserApiKeyState state, CustomResourceOptions options)
resources:  _:    type: equinix-metal:UserApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
ReadOnly bool
Flag indicating whether the API key shoud be read-only
Token string
API token which can be used in Equinix Metal API clients
UserId string
UUID of the owner of the API key
Description string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
ReadOnly bool
Flag indicating whether the API key shoud be read-only
Token string
API token which can be used in Equinix Metal API clients
UserId string
UUID of the owner of the API key
description String
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly Boolean
Flag indicating whether the API key shoud be read-only
token String
API token which can be used in Equinix Metal API clients
userId String
UUID of the owner of the API key
description string
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly boolean
Flag indicating whether the API key shoud be read-only
token string
API token which can be used in Equinix Metal API clients
userId string
UUID of the owner of the API key
description str
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
read_only bool
Flag indicating whether the API key shoud be read-only
token str
API token which can be used in Equinix Metal API clients
user_id str
UUID of the owner of the API key
description String
Description string for the User API Key resource

  • read-only - Flag indicating whether the API key shoud be read-only
readOnly Boolean
Flag indicating whether the API key shoud be read-only
token String
API token which can be used in Equinix Metal API clients
userId String
UUID of the owner of the API key

Package Details

Repository
Equinix Metal pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes
This Pulumi package is based on the metal Terraform Provider.

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal