AzureSecrets Control

Properties   Methods   Events   Config Settings   Errors  

The AzureSecrets control makes it easy to interact with secrets in Azure Key Vaults.

Syntax

AzureSecrets

Remarks

The AzureSecrets control provides an easy-to-use interface for the secret-related functionality of the Azure Key Vault service. Azure Key Vault allows you to work with a few different kinds of resources, one of which is secrets (e.g., passwords, symmetric keys, etc.). This control helps you to create and manage said secrets. To work with asymmetric key pairs instead, refer to the AzureKeys control.

To begin, register for an Azure account and create one or more Key Vaults via the Azure Portal. Set the Vault property to the name of the vault you wish to work with.

This control requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The component has the following defaults:

Additionally, depending on how the application is registered (Ex. Single-tenant, Multi-tenant) and what OAuthGrantType is selected (Ex. Authorization Code, Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL, and OAuthServerTokenURL properties. See below for examples of the modified URLs:

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the control. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The control will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the control will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the control will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the control will use an authorization code to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the control will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: AzureSecrets azuresecrets = new AzureSecrets(); azuresecrets.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; azuresecrets.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; azuresecrets.OAuth.ClientId = CLIENT_ID; azuresecrets.OAuth.ClientSecret = SECRET_ID; azuresecrets.OAuth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; azuresecrets.OAuth.ServerAuthURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/authorize"; azuresecrets.OAuth.ServerTokenURL = "https://login.microsoftonline.com/" + TENANT_ID + "/oauth2/v2.0/token"; azuresecrets.Authorize(); Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the control will request the authorization server to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the control will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the control will authenticate as the resource owner. This allows for the control to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this OAuthGrantType the control requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the control to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access https://vault.azure.net/user_impersonation"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; azuresecrets.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Using the Control

Secrets can be created using the CreateSecret method. A secret's name must be set at the time of creation, and cannot be changed later. The secret's value and, optionally, content type must also be set, but can be changed at any time. To change a secret's value, create a new version of it using the CreateSecret method (which will always create a new version if a secret with the specified name already exists); to change a secret's content-type, use the UpdateSecret method.

To retrieve a secret and its information, use the GetSecret method.

When a secret will no long be used, it can be deleted using the DeleteSecret method. However, the secret will only be soft-deleted; by default, Azure will permanently delete it after the waiting period configured for the vault. During this waiting period, the soft-deleted secret may be recovered using RecoverSecret, or permanently deleted using PurgeSecret (assuming the currently-authenticated user has the permissions to do so). // Create a secret. azuresecrets.SecretData = "Test123"; azuresecrets.CreateSecret("mysecret", "text/plain"); // Download the secret value to a local file. azuresecrets.LocalFile = "C:\temp\secret.txt"; azuresecrets.GetSecret("mysecret"); // Create a new version of the secret. azuresecrets.SecretData = "Cats456"; azuresecrets.CreateSecret("mysecret", "text/plain"); // ... Some time later, when the secret is no longer needed ... azuresecrets.DeleteSecret("mysecret"); // At this point, the secret is only soft-deleted. It could be recovered... azuresecrets.RecoverSecret("mysecret"); // ...or permanently deleted. azuresecrets.PurgeSecret("mysecret");

To list secrets, use the ListSecrets method. This method is also used to list soft-deleted secrets if the GetDeleted configuration setting has been enabled first. To list a secret's versions, use the ListVersions method. (You cannot list a deleted secret's versions.) // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { azuresecrets.ListSecrets(); } while (!string.IsNullOrEmpty(azuresecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { azuresecrets.ListVersions("mysecret"); } while (!string.IsNullOrEmpty(azuresecrets.VersionMarker));

The control also supports a variety of other functionality, including:

• Enabling and disabling secrets with SetSecretEnabled.
• Tagging support using AddTag and the Tags properties.
• Secure secret backup and restoration using BackupSecret and RestoreSecret.
• And more!

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

Authorization Property (AzureSecrets Control)

OAuth 2.0 Authorization Token.

Syntax

azuresecretscontrol.Authorization[=string]

Default Value

""

Remarks

This control supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth control or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN

Data Type

String

EncodeData Property (AzureSecrets Control)

Whether to automatically base64-encode and -decode secret data.

Syntax

azuresecretscontrol.EncodeData[=boolean]

Default Value

False

Remarks

This property specifies whether the control should automatically base64-encode secret data when it is uploaded by CreateSecret, and base64-decode it when it is downloaded with GetSecret.

Secrets are stored on the server as strings, and are transported via a JSON string property, so binary values must be encoded in some way; this property is provided as a convenience.

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (AzureSecrets Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

azuresecretscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AzureSecrets Control)

The type of firewall to connect through.

Syntax

azuresecretscontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AzureSecrets Control)

The name or IP address of the firewall (optional).

Syntax

azuresecretscontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (AzureSecrets Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

azuresecretscontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AzureSecrets Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

azuresecretscontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AzureSecrets Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

azuresecretscontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (AzureSecrets Control)

The current status of the control.

Syntax

azuresecretscontrol.Idle

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (AzureSecrets Control)

The local file to write data to, or whose data should be sent.

Syntax

azuresecretscontrol.LocalFile[=string]

Default Value

""

Remarks

This property specifies the location of a local file on disk. This is used as the source file when calling CreateSecret, and as the destination file when calling GetSecret.

Data Type

String

LocalHost Property (AzureSecrets Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

azuresecretscontrol.LocalHost[=string]

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OAuthAccessToken Property (AzureSecrets Control)

The access token returned by the authorization server.

Syntax

azuresecretscontrol.OAuthAccessToken[=string]

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the control makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (AzureSecrets Control)

The authorization code that is exchanged for an access token.

Syntax

azuresecretscontrol.OAuthAuthorizationCode[=string]

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (AzureSecrets Control)

The scope request or response parameter used during authorization.

Syntax

azuresecretscontrol.OAuthAuthorizationScope[=string]

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (AzureSecrets Control)

The id of the client assigned when registering the application.

Syntax

azuresecretscontrol.OAuthClientId[=string]

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (AzureSecrets Control)

The type of client that is requesting authorization.

Syntax

azuresecretscontrol.OAuthClientProfile[=integer]

Possible Values

cocpApplication(0), 
cocpWeb(1)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (AzureSecrets Control)

The secret value for the client assigned when registering the application.

Syntax

azuresecretscontrol.OAuthClientSecret[=string]

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (AzureSecrets Control)

The OAuth grant type used to acquire an OAuth access token.

Syntax

azuresecretscontrol.OAuthGrantType[=integer]

Possible Values

cogtAuthorizationCode(0), 
cogtImplicit(1), 
cogtPassword(2), 
cogtClientCredentials(3)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (AzureSecrets Control)

Specifies the refresh token received from or sent to the authorization server.

Syntax

azuresecretscontrol.OAuthRefreshToken[=string]

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (AzureSecrets Control)

Specifies whether the control will request a refresh token during authorization.

Syntax

azuresecretscontrol.OAuthRequestRefreshToken[=boolean]

Default Value

True

Remarks

Specifies whether the control will request a refresh token during authorization. By default, this value is True.

When True, the control will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (AzureSecrets Control)

The URL where the user (browser) returns after authenticating.

Syntax

azuresecretscontrol.OAuthReturnURL[=string]

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the control when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (AzureSecrets Control)

The URL of the authorization server.

Syntax

azuresecretscontrol.OAuthServerAuthURL[=string]

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (AzureSecrets Control)

The URL of the token server used to obtain the access token.

Syntax

azuresecretscontrol.OAuthServerTokenURL[=string]

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (AzureSecrets Control)

The URL to which the user should be re-directed for authorization.

Syntax

azuresecretscontrol.OAuthWebAuthURL

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (AzureSecrets Control)

Other headers as determined by the user (optional).

Syntax

azuresecretscontrol.OtherHeaders[=string]

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the control beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (AzureSecrets Control)

Whether the local file should be overwritten if necessary.

Syntax

azuresecretscontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property controls whether the specified LocalFile should be overwritten if it already exists.

This property is not available at design time.

Data Type

Boolean

ParsedHeaderCount Property (AzureSecrets Control)

The number of records in the ParsedHeader arrays.

Syntax

azuresecretscontrol.ParsedHeaderCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (AzureSecrets Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

azuresecretscontrol.ParsedHeaderField(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (AzureSecrets Control)

This property contains the header contents.

Syntax

azuresecretscontrol.ParsedHeaderValue(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (AzureSecrets Control)

The type of authorization to perform when connecting to the proxy.

Syntax

azuresecretscontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AzureSecrets Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

azuresecretscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (AzureSecrets Control)

A password if authentication is to be used for the proxy.

Syntax

azuresecretscontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AzureSecrets Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

azuresecretscontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AzureSecrets Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

azuresecretscontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AzureSecrets Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

azuresecretscontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AzureSecrets Control)

A username if authentication is to be used for the proxy.

Syntax

azuresecretscontrol.ProxyUser[=string]

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (AzureSecrets Control)

The number of records in the QueryParam arrays.

Syntax

azuresecretscontrol.QueryParamCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (AzureSecrets Control)

The name of the query parameter.

Syntax

azuresecretscontrol.QueryParamName(QueryParamIndex)[=string]

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (AzureSecrets Control)

The value of the query parameter.

Syntax

azuresecretscontrol.QueryParamValue(QueryParamIndex)[=string]

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The control will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

SecretData Property (AzureSecrets Control)

The secret data that was retrieved, or that should be sent.

Syntax

azuresecretscontrol.SecretData[=string]

Default Value

""

Remarks

This property is populated with secret data after calling GetSecret if LocalFile is not set.

This property can also be set before calling CreateSecret; its data will be sent if LocalFile is not set.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SecretDataB.

This property is not available at design time.

Data Type

Binary String

SecretMarker Property (AzureSecrets Control)

A marker indicating what page of secrets to return next.

Syntax

azuresecretscontrol.SecretMarker[=string]

Default Value

""

Remarks

This property will be populated when ListSecrets is called if the results are paged and there are more pages. To list all secrets, continue to call ListSecrets until this property returns empty string.

Refer to ListSecrets for more information.

This property is not available at design time.

Data Type

String

SecretCount Property (AzureSecrets Control)

The number of records in the Secret arrays.

Syntax

azuresecretscontrol.SecretCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SecretContentType
• SecretCreationDate
• SecretDeletionDate
• SecretEnabled
• SecretExpiryDate
• SecretName
• SecretNotBeforeDate
• SecretPurgeDate
• SecretRecoverableDays
• SecretRecoveryLevel
• SecretUpdateDate
• SecretVersionId

The array indices start at 0 and end at SecretCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SecretContentType Property (AzureSecrets Control)

The content type of the secret.

Syntax

azuresecretscontrol.SecretContentType(SecretIndex)

Default Value

""

Remarks

The content type of the secret.

This property reflects the content type of the secret.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

String

SecretCreationDate Property (AzureSecrets Control)

The creation date of the secret.

Syntax

azuresecretscontrol.SecretCreationDate(SecretIndex)

Default Value

-1

Remarks

The creation date of the secret.

This property reflects the creation date of the secret, in seconds since the Unix epoch.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretDeletionDate Property (AzureSecrets Control)

The deletion date of the secret.

Syntax

azuresecretscontrol.SecretDeletionDate(SecretIndex)

Default Value

-1

Remarks

The deletion date of the secret.

This property reflects the deletion date of the secret, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretEnabled Property (AzureSecrets Control)

Whether the secret is enabled.

Syntax

azuresecretscontrol.SecretEnabled(SecretIndex)

Default Value

False

Remarks

Whether the secret is enabled.

This property reflects whether the secret is currently enabled.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SecretExpiryDate Property (AzureSecrets Control)

The expiration date of the secret.

Syntax

azuresecretscontrol.SecretExpiryDate(SecretIndex)

Default Value

-1

Remarks

The expiration date of the secret.

This property reflects the expiration date of the secret, in seconds since the Unix epoch, or -1 if the secret does not expire.

Note that this property is purely informational; Azure does not enforce any additional restrictions based on whether the secret has expired.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretName Property (AzureSecrets Control)

The name of the secret.

Syntax

azuresecretscontrol.SecretName(SecretIndex)

Default Value

""

Remarks

The name of the secret.

This property reflects the name of the secret.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

String

SecretNotBeforeDate Property (AzureSecrets Control)

The 'not before' date of the secret.

Syntax

azuresecretscontrol.SecretNotBeforeDate(SecretIndex)

Default Value

-1

Remarks

The 'not before' date of the secret.

This property reflects the "not before" date of the secret, in seconds since the Unix epoch, or -1 if the secret doesn't have an explicit "not before" date.

Note that this property is purely informational; Azure does not enforce any additional restrictions based on whether the secret is awaiting its "not before" date.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretPurgeDate Property (AzureSecrets Control)

The purge date of the secret.

Syntax

azuresecretscontrol.SecretPurgeDate(SecretIndex)

Default Value

-1

Remarks

The purge date of the secret.

This property reflects the purge (i.e., permanent deletion) date of the secret, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretRecoverableDays Property (AzureSecrets Control)

The number of days the secret will be recoverable if it gets deleted.

Syntax

azuresecretscontrol.SecretRecoverableDays(SecretIndex)

Default Value

0

Remarks

The number of days the secret will be recoverable if it gets deleted.

This property reflects the number of days that the secret will be recoverable for if it gets deleted.

Note that this property's value is based on the retention policy of the currently-selected Vault; it will not change after the secret has actually been deleted.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Integer

SecretRecoveryLevel Property (AzureSecrets Control)

The secret's ability to be recovered and/or purged if it gets deleted.

Syntax

azuresecretscontrol.SecretRecoveryLevel(SecretIndex)

Default Value

""

Remarks

The secret's ability to be recovered and/or purged if it gets deleted.

This property reflects the secret's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:

• CustomizedRecoverable
• CustomizedRecoverable+ProtectedSubscription
• CustomizedRecoverable+Purgeable
• Purgeable
• Recoverable
• Recoverable+ProtectedSubscription
• Recoverable+Purgeable

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

String

SecretUpdateDate Property (AzureSecrets Control)

The update date of the secret.

Syntax

azuresecretscontrol.SecretUpdateDate(SecretIndex)

Default Value

-1

Remarks

The update date of the secret.

This property reflects the update date of the secret, in seconds since the Unix epoch.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

Long64

SecretVersionId Property (AzureSecrets Control)

The version Id of the secret.

Syntax

azuresecretscontrol.SecretVersionId(SecretIndex)

Default Value

""

Remarks

The version Id of the secret.

This property reflects the version Id of the secret.

The SecretIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretCount property.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (AzureSecrets Control)

The date on which this certificate becomes valid.

Syntax

azuresecretscontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (AzureSecrets Control)

The date on which the certificate expires.

Syntax

azuresecretscontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (AzureSecrets Control)

A comma-delimited list of extended key usage identifiers.

Syntax

azuresecretscontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (AzureSecrets Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (AzureSecrets Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (AzureSecrets Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (AzureSecrets Control)

The issuer of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (AzureSecrets Control)

The private key of the certificate (if available).

Syntax

azuresecretscontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (AzureSecrets Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (AzureSecrets Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

azuresecretscontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (AzureSecrets Control)

The public key of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (AzureSecrets Control)

The textual description of the certificate's public key algorithm.

Syntax

azuresecretscontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (AzureSecrets Control)

The length of the certificate's public key (in bits).

Syntax

azuresecretscontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (AzureSecrets Control)

The serial number of the certificate encoded as a string.

Syntax

azuresecretscontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (AzureSecrets Control)

The text description of the certificate's signature algorithm.

Syntax

azuresecretscontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (AzureSecrets Control)

The name of the certificate store for the client certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AzureSecrets Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

azuresecretscontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (AzureSecrets Control)

The type of certificate store for this certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (AzureSecrets Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (AzureSecrets Control)

The MD5 hash of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (AzureSecrets Control)

The SHA-1 hash of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (AzureSecrets Control)

The SHA-256 hash of the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (AzureSecrets Control)

The text description of UsageFlags .

Syntax

azuresecretscontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (AzureSecrets Control)

The flags that show intended use for the certificate.

Syntax

azuresecretscontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (AzureSecrets Control)

The certificate's version number.

Syntax

azuresecretscontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (AzureSecrets Control)

The subject of the certificate used for client authentication.

Syntax

azuresecretscontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (AzureSecrets Control)

The certificate (PEM/Base64 encoded).

Syntax

azuresecretscontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (AzureSecrets Control)

The date on which this certificate becomes valid.

Syntax

azuresecretscontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (AzureSecrets Control)

The date on which the certificate expires.

Syntax

azuresecretscontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (AzureSecrets Control)

A comma-delimited list of extended key usage identifiers.

Syntax

azuresecretscontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (AzureSecrets Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (AzureSecrets Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (AzureSecrets Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (AzureSecrets Control)

The issuer of the certificate.

Syntax

azuresecretscontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (AzureSecrets Control)

The private key of the certificate (if available).

Syntax

azuresecretscontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (AzureSecrets Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

azuresecretscontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (AzureSecrets Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

azuresecretscontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (AzureSecrets Control)

The public key of the certificate.

Syntax

azuresecretscontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (AzureSecrets Control)

The textual description of the certificate's public key algorithm.

Syntax

azuresecretscontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (AzureSecrets Control)

The length of the certificate's public key (in bits).

Syntax

azuresecretscontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (AzureSecrets Control)

The serial number of the certificate encoded as a string.

Syntax

azuresecretscontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (AzureSecrets Control)

The text description of the certificate's signature algorithm.

Syntax

azuresecretscontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (AzureSecrets Control)

The name of the certificate store for the client certificate.

Syntax

azuresecretscontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AzureSecrets Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

azuresecretscontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AzureSecrets Control)

The type of certificate store for this certificate.

Syntax

azuresecretscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (AzureSecrets Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

azuresecretscontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (AzureSecrets Control)

The MD5 hash of the certificate.

Syntax

azuresecretscontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (AzureSecrets Control)

The SHA-1 hash of the certificate.

Syntax

azuresecretscontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (AzureSecrets Control)

The SHA-256 hash of the certificate.

Syntax

azuresecretscontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (AzureSecrets Control)

The text description of UsageFlags .

Syntax

azuresecretscontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (AzureSecrets Control)

The flags that show intended use for the certificate.

Syntax

azuresecretscontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (AzureSecrets Control)

The certificate's version number.

Syntax

azuresecretscontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (AzureSecrets Control)

The subject of the certificate used for client authentication.

Syntax

azuresecretscontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (AzureSecrets Control)

The certificate (PEM/Base64 encoded).

Syntax

azuresecretscontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (AzureSecrets Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

azuresecretscontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (AzureSecrets Control)

The date on which this certificate becomes valid.

Syntax

azuresecretscontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (AzureSecrets Control)

The date on which the certificate expires.

Syntax

azuresecretscontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (AzureSecrets Control)

A comma-delimited list of extended key usage identifiers.

Syntax

azuresecretscontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (AzureSecrets Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (AzureSecrets Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (AzureSecrets Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

azuresecretscontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (AzureSecrets Control)

The issuer of the certificate.

Syntax

azuresecretscontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (AzureSecrets Control)

The private key of the certificate (if available).

Syntax

azuresecretscontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (AzureSecrets Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

azuresecretscontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (AzureSecrets Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

azuresecretscontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (AzureSecrets Control)

The public key of the certificate.

Syntax

azuresecretscontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (AzureSecrets Control)

The textual description of the certificate's public key algorithm.

Syntax

azuresecretscontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (AzureSecrets Control)

The length of the certificate's public key (in bits).

Syntax

azuresecretscontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (AzureSecrets Control)

The serial number of the certificate encoded as a string.

Syntax

azuresecretscontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (AzureSecrets Control)

The text description of the certificate's signature algorithm.

Syntax

azuresecretscontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (AzureSecrets Control)

The name of the certificate store for the client certificate.

Syntax

azuresecretscontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (AzureSecrets Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

azuresecretscontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (AzureSecrets Control)

The type of certificate store for this certificate.

Syntax

azuresecretscontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (AzureSecrets Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

azuresecretscontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (AzureSecrets Control)

The MD5 hash of the certificate.

Syntax

azuresecretscontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (AzureSecrets Control)

The SHA-1 hash of the certificate.

Syntax

azuresecretscontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (AzureSecrets Control)

The SHA-256 hash of the certificate.

Syntax

azuresecretscontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (AzureSecrets Control)

The text description of UsageFlags .

Syntax

azuresecretscontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (AzureSecrets Control)

The flags that show intended use for the certificate.

Syntax

azuresecretscontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (AzureSecrets Control)

The certificate's version number.

Syntax

azuresecretscontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (AzureSecrets Control)

The subject of the certificate used for client authentication.

Syntax

azuresecretscontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (AzureSecrets Control)

The certificate (PEM/Base64 encoded).

Syntax

azuresecretscontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

TagCount Property (AzureSecrets Control)

The number of records in the Tag arrays.

Syntax

azuresecretscontrol.TagCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TagName
• TagValue

The array indices start at 0 and end at TagCount - 1.

This property is not available at design time.

Data Type

Integer

TagName Property (AzureSecrets Control)

The name of the tag.

Syntax

azuresecretscontrol.TagName(TagIndex)[=string]

Default Value

""

Remarks

The name of the tag.

This property specifies the name of the tag.

The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.

This property is not available at design time.

Data Type

String

TagValue Property (AzureSecrets Control)

The value of the tag.

Syntax

azuresecretscontrol.TagValue(TagIndex)[=string]

Default Value

""

Remarks

The value of the tag.

This property specifies the value of the tag.

The TagIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TagCount property.

This property is not available at design time.

Data Type

String

Timeout Property (AzureSecrets Control)

The timeout for the control.

Syntax

azuresecretscontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Vault Property (AzureSecrets Control)

Selects a vault for the control to interact with.

Syntax

azuresecretscontrol.Vault[=string]

Default Value

""

Remarks

This property specifies the Azure Key Vault vault, by name, that the control should interact with.

Data Type

String

VersionMarker Property (AzureSecrets Control)

A marker indicating what page of secret versions to return next.

Syntax

azuresecretscontrol.VersionMarker[=string]

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all secret versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AddQueryParam Method (AzureSecrets Control)

Adds a query parameter to the QueryParams properties.

Syntax

azuresecretscontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the control automatically. Consult the service documentation for details on the available parameters.

AddTag Method (AzureSecrets Control)

Adds an item to the Tags properties.

Syntax

azuresecretscontrol.AddTag Name, Value

Remarks

This method adds an item to the Tags properties. Name specifies the name of the item, and Value specifies the value of the item.

Authorize Method (AzureSecrets Control)

Get the authorization string required to access the protected resource.

Syntax

azuresecretscontrol.Authorize 

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

BackupSecret Method (AzureSecrets Control)

Backs up a secret.

Syntax

azuresecretscontrol.BackupSecret SecretName

Remarks

This method backs up the secret specified by SecretName, returning it in a protected form via the the specified LocalFile or the SecretData property.

Note that the protected secret cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreSecret method in order to be used.

Config Method (AzureSecrets Control)

Sets or retrieves a configuration setting.

Syntax

azuresecretscontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateSecret Method (AzureSecrets Control)

Creates a new secret.

Syntax

azuresecretscontrol.CreateSecret SecretName, ContentType

Remarks

This method creates a new secret with the given SecretName. If a secret with the specified SecretName already exists, a new version of it is created. The version Id of the newly-created secret is returned.

The secret value is taken from the specified LocalFile or the SecretData property. If the EncodeData property is enabled, the value will be base64-encoded before it is sent.

The value passed for SecretName must consist solely of alphanumeric characters and hyphens (-).

The ContentType parameter is optional, and can be set to any string value.

If there are any items in the Tags properties, they will be applied to the newly-created secret. Secrets may have up to 15 tags.

The following configuration settings can also be used to send additional values when creating the secret, refer to their documentation for more information:

• CreateSecretEnabled
• ExpiryDate
• NotBeforeDate

Note: If there is already a soft-deleted secret with the specified SecretName in the currently-selected Vault, then a new secret cannot be created with the same name. To resolve such a situation, the soft-deleted secret would need to be recovered (using RecoverSecret) or permanently deleted (using PurgeSecret) first.

DeleteSecret Method (AzureSecrets Control)

Deletes a secret.

Syntax

azuresecretscontrol.DeleteSecret SecretName

Remarks

This method deletes the secret specified by SecretName. If there are multiple versions of the secret, all of them are deleted.

Note that the secret is only soft-deleted; it can be recovered during the retention period using the RecoverSecret method, or permanently deleted using the PurgeSecret method. The length of the retention period depends on the configuration of the currently-selected Vault, refer to the Azure Key Vault documentation for more information.

DoEvents Method (AzureSecrets Control)

This method processes events from the internal message queue.

Syntax

azuresecretscontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetSecret Method (AzureSecrets Control)

Gets a secret's value and information.

Syntax

azuresecretscontrol.GetSecret SecretName

Remarks

This method gets the value and information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version. The secret's value is returned via the specified LocalFile or the SecretData property.

Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted secret's information (but not its value).

When the information is returned, the control clears the Secrets properties and repopulates it properties with the secret's tags. The SecretList and TagList events are also fired.

ListSecrets Method (AzureSecrets Control)

Lists the secrets in the currently-selected vault.

Syntax

azuresecretscontrol.ListSecrets 

Remarks

This method lists the secrets in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted secrets in the vault instead.

Calling this method will fire the SecretList event once for each secret, and will also populate the Secrets properties.

If there are still more secrets available to list when this method returns, the SecretMarker property will be populated. Continue to call this method until SecretMarker is empty to accumulate all pages of results in the Secrets properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

ListVersions Method (AzureSecrets Control)

Lists versions of a secret.

Syntax

azuresecretscontrol.ListVersions SecretName

Remarks

This method lists the versions of the secret specified by SecretName.

Calling this method will fire the SecretList event once for each secret version, and will also populate the Secrets properties.

If there are still more secret versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Secrets properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

PurgeSecret Method (AzureSecrets Control)

Permanently deletes a soft-deleted secret.

Syntax

azuresecretscontrol.PurgeSecret SecretName

Remarks

This method permanently deletes the soft-deleted secret specified by SecretName.

RecoverSecret Method (AzureSecrets Control)

Recovers a soft-deleted secret.

Syntax

azuresecretscontrol.RecoverSecret SecretName

Remarks

This method recovers the soft-deleted secret specified by SecretName.

Reset Method (AzureSecrets Control)

Resets the control to its initial state.

Syntax

azuresecretscontrol.Reset 

Remarks

This method resets the control to its initial state.

RestoreSecret Method (AzureSecrets Control)

Restores a previously backed-up secret to the vault.

Syntax

azuresecretscontrol.RestoreSecret 

Remarks

This method restores a secret previously backed up using BackupSecret to the currently-selected Vault. The secret is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the secret's name is already in use. The name of the restored secret is returned.

The protected secret data to restore is taken from the the specified LocalFile or the SecretData property.

Note: There are certain restrictions on which vaults a secret can be restored to. In particular, a secret must be restored to a vault owned by the same Azure subscription that owned its original vault, and must be restored to a vault in the same geolocation as its original vault. Refer to the Azure Key Vault documentation for more information.

SetSecretEnabled Method (AzureSecrets Control)

Enables or disables a secret.

Syntax

azuresecretscontrol.SetSecretEnabled SecretName, Enabled

Remarks

This method enables or disables the secret specified by SecretName.

UpdateSecret Method (AzureSecrets Control)

Updates a secret's information.

Syntax

azuresecretscontrol.UpdateSecret SecretName, ContentType, UpdateTags

Remarks

This method updates the information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version.

The ContentType parameter, if non-empty, can be any string value. If empty, the secret's current content type is left unchanged. (To explicitly clear the secret's content type, pass %CLEAR%).

The UpdateTags parameter determines whether the control replaces the secret's current tags with the items in the Tags properties (which may be empty). Secrets may have up to 15 tags.

The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.

EndTransfer Event (AzureSecrets Control)

This event fires when a document finishes transferring.

Syntax

Sub azuresecretscontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AzureSecrets Control)

Fired when information is available about errors during data delivery.

Syntax

Sub azuresecretscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AzureSecrets Control)

Fired every time a header line comes in.

Syntax

Sub azuresecretscontrol_Header(Field As String, Value As String)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AzureSecrets Control)

Fired once for each log message.

Syntax

Sub azuresecretscontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SecretList Event (AzureSecrets Control)

Fires once for each secret when listing secrets.

Syntax

Sub azuresecretscontrol_SecretList(Name As String, VersionId As String, ContentType As String, Enabled As Boolean, CreationDate As Long64, UpdateDate As Long64, DeletionDate As Long64, PurgeDate As Long64)

Remarks

This event fires once for each secret (or secret version) returned when ListSecrets, ListVersions, or GetSecret is called.

Name reflects the name of the secret.

VersionId reflects the Id of the secret version.

ContentType reflects the secret's content type.

Enabled reflects whether the secret is currently enabled.

CreationDate reflects the secret's creation date, in seconds since the Unix epoch.

UpdateDate reflects the secret's update date, in seconds since the Unix epoch.

DeletionDate reflects the secret's deletion date, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

PurgeDate reflects the secret's purge (i.e., permanent deletion) date, in seconds since the Unix epoch, or -1 if the secret has not been deleted.

SSLServerAuthentication Event (AzureSecrets Control)

Fired after the server presents its certificate to the client.

Syntax

Sub azuresecretscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AzureSecrets Control)

Fired when secure connection progress messages are available.

Syntax

Sub azuresecretscontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AzureSecrets Control)

This event fires when a document starts transferring (after the headers).

Syntax

Sub azuresecretscontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

TagList Event (AzureSecrets Control)

Fires once for each tag returned when a secret is retrieved.

Syntax

Sub azuresecretscontrol_TagList(SecretName As String, VersionId As String, Name As String, Value As String)

Remarks

This event fires once for each tag returned when GetSecret is called.

SecretName reflects the name of the secret.

VersionId reflects the Id of the secret version.

Name reflects the name of the tag.

Value reflects the value of the tag.

Transfer Event (AzureSecrets Control)

Fired while a document transfers (delivers document).

Syntax

Sub azuresecretscontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AzureSecrets Control)

AzureSecrets Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AzureSecrets Control)

Common Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors