Class SecretValueReference

Reference to a Key Vault secret.

Inheritance

System.Object

SecretValueReference

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.ResourceManager.Blueprint.dll

Syntax

public class SecretValueReference : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Blueprint.Models.SecretValueReference>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Blueprint.Models.SecretValueReference>

Constructors

SecretValueReference(WritableSubResource, String)

Initializes a new instance of SecretValueReference.

Declaration

public SecretValueReference (Azure.ResourceManager.Resources.Models.WritableSubResource keyVault, string secretName);

Parameters

Azure.ResourceManager.Resources.Models.WritableSubResource keyVault Specifies the reference to a given Azure Key Vault.

System.String secretName Name of the secret.

Exceptions

System.ArgumentNullException keyVault or secretName is null.

Properties

KeyVaultId

Gets or sets Id.

Declaration

public Azure.Core.ResourceIdentifier KeyVaultId { get; set; }

Property Value

Azure.Core.ResourceIdentifier

SecretName

Name of the secret.

Declaration

public string SecretName { get; set; }

Property Value

System.String

SecretVersion

The version of the secret to use. If left blank, the latest version of the secret is used.

Declaration

public string SecretVersion { get; set; }

Property Value

System.String

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<SecretValueReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration

Azure.ResourceManager.Blueprint.Models.SecretValueReference IJsonModel<SecretValueReference>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

SecretValueReference A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<SecretValueReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<SecretValueReference>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<SecretValueReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.ResourceManager.Blueprint.Models.SecretValueReference IPersistableModel<SecretValueReference>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

SecretValueReference A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<SecretValueReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

string IPersistableModel<SecretValueReference>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the serivce.

IPersistableModel<SecretValueReference>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<SecretValueReference>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.