azure-native-v2.sql.ManagedInstanceKey
Explore with Pulumi AI
A managed instance key. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2020-11-01-preview.
Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.
Create ManagedInstanceKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagedInstanceKey(name: string, args: ManagedInstanceKeyArgs, opts?: CustomResourceOptions);
@overload
def ManagedInstanceKey(resource_name: str,
args: ManagedInstanceKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ManagedInstanceKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
managed_instance_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
server_key_type: Optional[Union[str, ServerKeyType]] = None,
key_name: Optional[str] = None,
uri: Optional[str] = None)
func NewManagedInstanceKey(ctx *Context, name string, args ManagedInstanceKeyArgs, opts ...ResourceOption) (*ManagedInstanceKey, error)
public ManagedInstanceKey(string name, ManagedInstanceKeyArgs args, CustomResourceOptions? opts = null)
public ManagedInstanceKey(String name, ManagedInstanceKeyArgs args)
public ManagedInstanceKey(String name, ManagedInstanceKeyArgs args, CustomResourceOptions options)
type: azure-native:sql:ManagedInstanceKey
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. ManagedInstanceKeyArgs - 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. ManagedInstanceKeyArgs - 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. ManagedInstanceKeyArgs - 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. ManagedInstanceKeyArgs - 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. ManagedInstanceKeyArgs - 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 managedInstanceKeyResource = new AzureNative.Sql.ManagedInstanceKey("managedInstanceKeyResource", new()
{
ManagedInstanceName = "string",
ResourceGroupName = "string",
ServerKeyType = "string",
KeyName = "string",
Uri = "string",
});
example, err := sql.NewManagedInstanceKey(ctx, "managedInstanceKeyResource", &sql.ManagedInstanceKeyArgs{
ManagedInstanceName: "string",
ResourceGroupName: "string",
ServerKeyType: "string",
KeyName: "string",
Uri: "string",
})
var managedInstanceKeyResource = new ManagedInstanceKey("managedInstanceKeyResource", ManagedInstanceKeyArgs.builder()
.managedInstanceName("string")
.resourceGroupName("string")
.serverKeyType("string")
.keyName("string")
.uri("string")
.build());
managed_instance_key_resource = azure_native.sql.ManagedInstanceKey("managedInstanceKeyResource",
managed_instance_name=string,
resource_group_name=string,
server_key_type=string,
key_name=string,
uri=string)
const managedInstanceKeyResource = new azure_native.sql.ManagedInstanceKey("managedInstanceKeyResource", {
managedInstanceName: "string",
resourceGroupName: "string",
serverKeyType: "string",
keyName: "string",
uri: "string",
});
type: azure-native:sql:ManagedInstanceKey
properties:
keyName: string
managedInstanceName: string
resourceGroupName: string
serverKeyType: string
uri: string
ManagedInstanceKey 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 ManagedInstanceKey resource accepts the following input properties:
- Managed
Instance Name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Server
Key Type This property is required. Changes to this property will trigger replacement.
Azure Native. Sql. Server Key Type - The key type like 'ServiceManaged', 'AzureKeyVault'.
- Key
Name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- Uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
- Managed
Instance Name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Server
Key Type This property is required. Changes to this property will trigger replacement.
Key Type - The key type like 'ServiceManaged', 'AzureKeyVault'.
- Key
Name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- Uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
- managed
Instance Name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Key Type This property is required. Changes to this property will trigger replacement.
Key Type - The key type like 'ServiceManaged', 'AzureKeyVault'.
- key
Name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
- managed
Instance Name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Key Type This property is required. Changes to this property will trigger replacement.
Key Type - The key type like 'ServiceManaged', 'AzureKeyVault'.
- key
Name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
- managed_
instance_ name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server_
key_ type This property is required. Changes to this property will trigger replacement.
Key Type - The key type like 'ServiceManaged', 'AzureKeyVault'.
- key_
name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
- managed
Instance Name This property is required. Changes to this property will trigger replacement.
- The name of the managed instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Key Type This property is required. Changes to this property will trigger replacement.
Managed" | "Azure Key Vault" - The key type like 'ServiceManaged', 'AzureKeyVault'.
- key
Name Changes to this property will trigger replacement.
- The name of the managed instance key to be operated on (updated or created).
- uri
Changes to this property will trigger replacement.
- The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagedInstanceKey resource produces the following output properties:
- Auto
Rotation boolEnabled - Key auto rotation opt-in flag. Either true or false.
- Creation
Date string - The key creation date.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- Name string
- Resource name.
- Thumbprint string
- Thumbprint of the key.
- Type string
- Resource type.
- Auto
Rotation boolEnabled - Key auto rotation opt-in flag. Either true or false.
- Creation
Date string - The key creation date.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kind string
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- Name string
- Resource name.
- Thumbprint string
- Thumbprint of the key.
- Type string
- Resource type.
- auto
Rotation BooleanEnabled - Key auto rotation opt-in flag. Either true or false.
- creation
Date String - The key creation date.
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- name String
- Resource name.
- thumbprint String
- Thumbprint of the key.
- type String
- Resource type.
- auto
Rotation booleanEnabled - Key auto rotation opt-in flag. Either true or false.
- creation
Date string - The key creation date.
- id string
- The provider-assigned unique ID for this managed resource.
- kind string
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- name string
- Resource name.
- thumbprint string
- Thumbprint of the key.
- type string
- Resource type.
- auto_
rotation_ boolenabled - Key auto rotation opt-in flag. Either true or false.
- creation_
date str - The key creation date.
- id str
- The provider-assigned unique ID for this managed resource.
- kind str
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- name str
- Resource name.
- thumbprint str
- Thumbprint of the key.
- type str
- Resource type.
- auto
Rotation BooleanEnabled - Key auto rotation opt-in flag. Either true or false.
- creation
Date String - The key creation date.
- id String
- The provider-assigned unique ID for this managed resource.
- kind String
- Kind of encryption protector. This is metadata used for the Azure portal experience.
- name String
- Resource name.
- thumbprint String
- Thumbprint of the key.
- type String
- Resource type.
Supporting Types
ServerKeyType, ServerKeyTypeArgs
- Service
Managed - ServiceManaged
- Azure
Key Vault - AzureKeyVault
- Server
Key Type Service Managed - ServiceManaged
- Server
Key Type Azure Key Vault - AzureKeyVault
- Service
Managed - ServiceManaged
- Azure
Key Vault - AzureKeyVault
- Service
Managed - ServiceManaged
- Azure
Key Vault - AzureKeyVault
- SERVICE_MANAGED
- ServiceManaged
- AZURE_KEY_VAULT
- AzureKeyVault
- "Service
Managed" - ServiceManaged
- "Azure
Key Vault" - AzureKeyVault
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:sql:ManagedInstanceKey sqlcrudtest-4645 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0