databricks.SecretScope
Explore with Pulumi AI
Import
The secret resource scope can be imported using the scope name. initial_manage_principal
state won’t be imported, because the underlying API doesn’t include it in the response. bash
$ pulumi import databricks:index/secretScope:SecretScope object <scopeName>
Create SecretScope Resource
new SecretScope(name: string, args?: SecretScopeArgs, opts?: CustomResourceOptions);
@overload
def SecretScope(resource_name: str,
opts: Optional[ResourceOptions] = None,
backend_type: Optional[str] = None,
initial_manage_principal: Optional[str] = None,
keyvault_metadata: Optional[SecretScopeKeyvaultMetadataArgs] = None,
name: Optional[str] = None)
@overload
def SecretScope(resource_name: str,
args: Optional[SecretScopeArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewSecretScope(ctx *Context, name string, args *SecretScopeArgs, opts ...ResourceOption) (*SecretScope, error)
public SecretScope(string name, SecretScopeArgs? args = null, CustomResourceOptions? opts = null)
public SecretScope(String name, SecretScopeArgs args)
public SecretScope(String name, SecretScopeArgs args, CustomResourceOptions options)
type: databricks:SecretScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecretScopeArgs
- 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 SecretScopeArgs
- 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 SecretScopeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecretScopeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SecretScopeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SecretScope Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SecretScope resource accepts the following input properties:
- Backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- Initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- Keyvault
Metadata SecretScope Keyvault Metadata Args - Name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- Backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- Initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- Keyvault
Metadata SecretScope Keyvault Metadata Args - Name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type String Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage StringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata SecretScope Keyvault Metadata Args - name String
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata SecretScope Keyvault Metadata Args - name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend_
type str Either
DATABRICKS
orAZURE_KEYVAULT
- initial_
manage_ strprincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault_
metadata SecretScope Keyvault Metadata Args - name str
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type String Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage StringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata Property Map - name String
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecretScope 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 string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing SecretScope Resource
Get an existing SecretScope 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?: SecretScopeState, opts?: CustomResourceOptions): SecretScope
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backend_type: Optional[str] = None,
initial_manage_principal: Optional[str] = None,
keyvault_metadata: Optional[SecretScopeKeyvaultMetadataArgs] = None,
name: Optional[str] = None) -> SecretScope
func GetSecretScope(ctx *Context, name string, id IDInput, state *SecretScopeState, opts ...ResourceOption) (*SecretScope, error)
public static SecretScope Get(string name, Input<string> id, SecretScopeState? state, CustomResourceOptions? opts = null)
public static SecretScope get(String name, Output<String> id, SecretScopeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- Initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- Keyvault
Metadata SecretScope Keyvault Metadata Args - Name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- Backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- Initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- Keyvault
Metadata SecretScope Keyvault Metadata Args - Name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type String Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage StringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata SecretScope Keyvault Metadata Args - name String
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type string Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage stringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata SecretScope Keyvault Metadata Args - name string
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend_
type str Either
DATABRICKS
orAZURE_KEYVAULT
- initial_
manage_ strprincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault_
metadata SecretScope Keyvault Metadata Args - name str
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
- backend
Type String Either
DATABRICKS
orAZURE_KEYVAULT
- initial
Manage StringPrincipal The principal with the only possible value
users
that is initially grantedMANAGE
permission to the created scope. If it's omitted, then the databricks.SecretAcl withMANAGE
permission applied to the scope is assigned to the API request issuer's user identity (see documentation). This part of the state cannot be imported.- keyvault
Metadata Property Map - name String
Scope name requested by the user. Must be unique within a workspace. Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
Supporting Types
SecretScopeKeyvaultMetadata
- Dns
Name string - Resource
Id string
- Dns
Name string - Resource
Id string
- dns
Name String - resource
Id String
- dns
Name string - resource
Id string
- dns_
name str - resource_
id str
- dns
Name String - resource
Id String
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
databricks
Terraform Provider.