1. Docs
  2. Reference
  3. API
  4. Azure
  5. storage
  6. CustomerManagedKey

CustomerManagedKey

Manages a Customer Managed Key for a Storage Account.

Create a CustomerManagedKey Resource

new CustomerManagedKey(name: string, args: CustomerManagedKeyArgs, opts?: CustomResourceOptions);
def CustomerManagedKey(resource_name, opts=None, key_name=None, key_vault_id=None, key_version=None, storage_account_id=None, __props__=None);
func NewCustomerManagedKey(ctx *Context, name string, args CustomerManagedKeyArgs, opts ...ResourceOption) (*CustomerManagedKey, error)
public CustomerManagedKey(string name, CustomerManagedKeyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args CustomerManagedKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CustomerManagedKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CustomerManagedKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

CustomerManagedKey Resource Properties

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

Inputs

The CustomerManagedKey resource accepts the following input properties:

KeyName string

The name of Key Vault Key.

KeyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

KeyVersion string

The version of Key Vault Key.

StorageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

KeyName string

The name of Key Vault Key.

KeyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

KeyVersion string

The version of Key Vault Key.

StorageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

keyName string

The name of Key Vault Key.

keyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

keyVersion string

The version of Key Vault Key.

storageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

key_name str

The name of Key Vault Key.

key_vault_id str

The ID of the Key Vault. Changing this forces a new resource to be created.

key_version str

The version of Key Vault Key.

storage_account_id str

The ID of the Storage Account. Changing this forces a new resource to be created.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing CustomerManagedKey Resource

Get an existing CustomerManagedKey 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?: CustomerManagedKeyState, opts?: CustomResourceOptions): CustomerManagedKey
static get(resource_name, id, opts=None, key_name=None, key_vault_id=None, key_version=None, storage_account_id=None, __props__=None);
func GetCustomerManagedKey(ctx *Context, name string, id IDInput, state *CustomerManagedKeyState, opts ...ResourceOption) (*CustomerManagedKey, error)
public static CustomerManagedKey Get(string name, Input<string> id, CustomerManagedKeyState? 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:

KeyName string

The name of Key Vault Key.

KeyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

KeyVersion string

The version of Key Vault Key.

StorageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

KeyName string

The name of Key Vault Key.

KeyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

KeyVersion string

The version of Key Vault Key.

StorageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

keyName string

The name of Key Vault Key.

keyVaultId string

The ID of the Key Vault. Changing this forces a new resource to be created.

keyVersion string

The version of Key Vault Key.

storageAccountId string

The ID of the Storage Account. Changing this forces a new resource to be created.

key_name str

The name of Key Vault Key.

key_vault_id str

The ID of the Key Vault. Changing this forces a new resource to be created.

key_version str

The version of Key Vault Key.

storage_account_id str

The ID of the Storage Account. Changing this forces a new resource to be created.

Package Details

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