@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 2.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
*
* Uses Azure REST API version 2024-11-01.
*
* Other available API versions: 2023-02-01, 2023-07-01, 2024-04-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native keyvault [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSecret(args: GetSecretArgs, opts?: pulumi.InvokeOptions): Promise<GetSecretResult>;
export interface GetSecretArgs {
/**
* The name of the Resource Group to which the vault belongs.
*/
resourceGroupName: string;
/**
* The name of the secret.
*/
secretName: string;
/**
* The name of the vault.
*/
vaultName: string;
}
/**
* Resource information with extended details.
*/
export interface GetSecretResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Fully qualified identifier of the key vault resource.
*/
readonly id: string;
/**
* Azure location of the key vault resource.
*/
readonly location: string;
/**
* Name of the key vault resource.
*/
readonly name: string;
/**
* Properties of the secret
*/
readonly properties: outputs.keyvault.SecretPropertiesResponse;
/**
* Tags assigned to the key vault resource.
*/
readonly tags: {
[key: string]: string;
};
/**
* Resource type of the key vault resource.
*/
readonly type: string;
}
/**
* Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
*
* Uses Azure REST API version 2024-11-01.
*
* Other available API versions: 2023-02-01, 2023-07-01, 2024-04-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native keyvault [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSecretOutput(args: GetSecretOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSecretResult>;
export interface GetSecretOutputArgs {
/**
* The name of the Resource Group to which the vault belongs.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the secret.
*/
secretName: pulumi.Input<string>;
/**
* The name of the vault.
*/
vaultName: pulumi.Input<string>;
}