1. Packages
  2. Azure Native
  3. API Docs
  4. keyvault
  5. Secret
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.keyvault.Secret

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Resource information with extended details. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2019-09-01

    Example Usage

    Create a secret

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var secret = new AzureNative.KeyVault.Secret("secret", new()
        {
            Properties = new AzureNative.KeyVault.Inputs.SecretPropertiesArgs
            {
                Value = "secret-value",
            },
            ResourceGroupName = "sample-group",
            SecretName = "secret-name",
            VaultName = "sample-vault",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/keyvault/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := keyvault.NewSecret(ctx, "secret", &keyvault.SecretArgs{
    			Properties: &keyvault.SecretPropertiesArgs{
    				Value: pulumi.String("secret-value"),
    			},
    			ResourceGroupName: pulumi.String("sample-group"),
    			SecretName:        pulumi.String("secret-name"),
    			VaultName:         pulumi.String("sample-vault"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.keyvault.Secret;
    import com.pulumi.azurenative.keyvault.SecretArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var secret = new Secret("secret", SecretArgs.builder()        
                .properties(Map.of("value", "secret-value"))
                .resourceGroupName("sample-group")
                .secretName("secret-name")
                .vaultName("sample-vault")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    secret = azure_native.keyvault.Secret("secret",
        properties=azure_native.keyvault.SecretPropertiesArgs(
            value="secret-value",
        ),
        resource_group_name="sample-group",
        secret_name="secret-name",
        vault_name="sample-vault")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const secret = new azure_native.keyvault.Secret("secret", {
        properties: {
            value: "secret-value",
        },
        resourceGroupName: "sample-group",
        secretName: "secret-name",
        vaultName: "sample-vault",
    });
    
    resources:
      secret:
        type: azure-native:keyvault:Secret
        properties:
          properties:
            value: secret-value
          resourceGroupName: sample-group
          secretName: secret-name
          vaultName: sample-vault
    

    Create Secret Resource

    new Secret(name: string, args: SecretArgs, opts?: CustomResourceOptions);
    @overload
    def Secret(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               properties: Optional[SecretPropertiesArgs] = None,
               resource_group_name: Optional[str] = None,
               secret_name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               vault_name: Optional[str] = None)
    @overload
    def Secret(resource_name: str,
               args: SecretArgs,
               opts: Optional[ResourceOptions] = None)
    func NewSecret(ctx *Context, name string, args SecretArgs, opts ...ResourceOption) (*Secret, error)
    public Secret(string name, SecretArgs args, CustomResourceOptions? opts = null)
    public Secret(String name, SecretArgs args)
    public Secret(String name, SecretArgs args, CustomResourceOptions options)
    
    type: azure-native:keyvault:Secret
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SecretArgs
    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 SecretArgs
    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 SecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Secret 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 Secret resource accepts the following input properties:

    Properties Pulumi.AzureNative.KeyVault.Inputs.SecretProperties

    Properties of the secret

    ResourceGroupName string

    The name of the Resource Group to which the vault belongs.

    VaultName string

    Name of the vault

    SecretName string

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    Tags Dictionary<string, string>

    The tags that will be assigned to the secret.

    Properties SecretPropertiesArgs

    Properties of the secret

    ResourceGroupName string

    The name of the Resource Group to which the vault belongs.

    VaultName string

    Name of the vault

    SecretName string

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    Tags map[string]string

    The tags that will be assigned to the secret.

    properties SecretProperties

    Properties of the secret

    resourceGroupName String

    The name of the Resource Group to which the vault belongs.

    vaultName String

    Name of the vault

    secretName String

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    tags Map<String,String>

    The tags that will be assigned to the secret.

    properties SecretProperties

    Properties of the secret

    resourceGroupName string

    The name of the Resource Group to which the vault belongs.

    vaultName string

    Name of the vault

    secretName string

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    tags {[key: string]: string}

    The tags that will be assigned to the secret.

    properties SecretPropertiesArgs

    Properties of the secret

    resource_group_name str

    The name of the Resource Group to which the vault belongs.

    vault_name str

    Name of the vault

    secret_name str

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    tags Mapping[str, str]

    The tags that will be assigned to the secret.

    properties Property Map

    Properties of the secret

    resourceGroupName String

    The name of the Resource Group to which the vault belongs.

    vaultName String

    Name of the vault

    secretName String

    Name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

    tags Map<String>

    The tags that will be assigned to the secret.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Location string

    Azure location of the key vault resource.

    Name string

    Name of the key vault resource.

    Type string

    Resource type of the key vault resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    Location string

    Azure location of the key vault resource.

    Name string

    Name of the key vault resource.

    Type string

    Resource type of the key vault resource.

    id String

    The provider-assigned unique ID for this managed resource.

    location String

    Azure location of the key vault resource.

    name String

    Name of the key vault resource.

    type String

    Resource type of the key vault resource.

    id string

    The provider-assigned unique ID for this managed resource.

    location string

    Azure location of the key vault resource.

    name string

    Name of the key vault resource.

    type string

    Resource type of the key vault resource.

    id str

    The provider-assigned unique ID for this managed resource.

    location str

    Azure location of the key vault resource.

    name str

    Name of the key vault resource.

    type str

    Resource type of the key vault resource.

    id String

    The provider-assigned unique ID for this managed resource.

    location String

    Azure location of the key vault resource.

    name String

    Name of the key vault resource.

    type String

    Resource type of the key vault resource.

    Supporting Types

    SecretAttributes, SecretAttributesArgs

    Enabled bool

    Determines whether the object is enabled.

    Expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    NotBefore int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    Enabled bool

    Determines whether the object is enabled.

    Expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    NotBefore int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    enabled Boolean

    Determines whether the object is enabled.

    expires Integer

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore Integer

    Not before date in seconds since 1970-01-01T00:00:00Z.

    enabled boolean

    Determines whether the object is enabled.

    expires number

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore number

    Not before date in seconds since 1970-01-01T00:00:00Z.

    enabled bool

    Determines whether the object is enabled.

    expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    not_before int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    enabled Boolean

    Determines whether the object is enabled.

    expires Number

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore Number

    Not before date in seconds since 1970-01-01T00:00:00Z.

    SecretAttributesResponse, SecretAttributesResponseArgs

    Created int

    Creation time in seconds since 1970-01-01T00:00:00Z.

    Updated int

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    Enabled bool

    Determines whether the object is enabled.

    Expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    NotBefore int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    Created int

    Creation time in seconds since 1970-01-01T00:00:00Z.

    Updated int

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    Enabled bool

    Determines whether the object is enabled.

    Expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    NotBefore int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    created Integer

    Creation time in seconds since 1970-01-01T00:00:00Z.

    updated Integer

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    enabled Boolean

    Determines whether the object is enabled.

    expires Integer

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore Integer

    Not before date in seconds since 1970-01-01T00:00:00Z.

    created number

    Creation time in seconds since 1970-01-01T00:00:00Z.

    updated number

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    enabled boolean

    Determines whether the object is enabled.

    expires number

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore number

    Not before date in seconds since 1970-01-01T00:00:00Z.

    created int

    Creation time in seconds since 1970-01-01T00:00:00Z.

    updated int

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    enabled bool

    Determines whether the object is enabled.

    expires int

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    not_before int

    Not before date in seconds since 1970-01-01T00:00:00Z.

    created Number

    Creation time in seconds since 1970-01-01T00:00:00Z.

    updated Number

    Last updated time in seconds since 1970-01-01T00:00:00Z.

    enabled Boolean

    Determines whether the object is enabled.

    expires Number

    Expiry date in seconds since 1970-01-01T00:00:00Z.

    notBefore Number

    Not before date in seconds since 1970-01-01T00:00:00Z.

    SecretProperties, SecretPropertiesArgs

    Attributes Pulumi.AzureNative.KeyVault.Inputs.SecretAttributes

    The attributes of the secret.

    ContentType string

    The content type of the secret.

    Value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    Attributes SecretAttributes

    The attributes of the secret.

    ContentType string

    The content type of the secret.

    Value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    attributes SecretAttributes

    The attributes of the secret.

    contentType String

    The content type of the secret.

    value String

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    attributes SecretAttributes

    The attributes of the secret.

    contentType string

    The content type of the secret.

    value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    attributes SecretAttributes

    The attributes of the secret.

    content_type str

    The content type of the secret.

    value str

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    attributes Property Map

    The attributes of the secret.

    contentType String

    The content type of the secret.

    value String

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    SecretPropertiesResponse, SecretPropertiesResponseArgs

    SecretUri string

    The URI to retrieve the current version of the secret.

    SecretUriWithVersion string

    The URI to retrieve the specific version of the secret.

    Attributes Pulumi.AzureNative.KeyVault.Inputs.SecretAttributesResponse

    The attributes of the secret.

    ContentType string

    The content type of the secret.

    Value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    SecretUri string

    The URI to retrieve the current version of the secret.

    SecretUriWithVersion string

    The URI to retrieve the specific version of the secret.

    Attributes SecretAttributesResponse

    The attributes of the secret.

    ContentType string

    The content type of the secret.

    Value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    secretUri String

    The URI to retrieve the current version of the secret.

    secretUriWithVersion String

    The URI to retrieve the specific version of the secret.

    attributes SecretAttributesResponse

    The attributes of the secret.

    contentType String

    The content type of the secret.

    value String

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    secretUri string

    The URI to retrieve the current version of the secret.

    secretUriWithVersion string

    The URI to retrieve the specific version of the secret.

    attributes SecretAttributesResponse

    The attributes of the secret.

    contentType string

    The content type of the secret.

    value string

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    secret_uri str

    The URI to retrieve the current version of the secret.

    secret_uri_with_version str

    The URI to retrieve the specific version of the secret.

    attributes SecretAttributesResponse

    The attributes of the secret.

    content_type str

    The content type of the secret.

    value str

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    secretUri String

    The URI to retrieve the current version of the secret.

    secretUriWithVersion String

    The URI to retrieve the specific version of the secret.

    attributes Property Map

    The attributes of the secret.

    contentType String

    The content type of the secret.

    value String

    The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:keyvault:Secret secret-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi