132 строки
10 KiB
YAML
132 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.models.EncryptionKey"
|
|
fullName: "com.azure.search.models.EncryptionKey"
|
|
name: "EncryptionKey"
|
|
nameWithType: "EncryptionKey"
|
|
summary: "A customer-managed encryption key in Azure Key Vault."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **EncryptionKey**"
|
|
constructors:
|
|
- uid: "com.azure.search.models.EncryptionKey.EncryptionKey()"
|
|
fullName: "com.azure.search.models.EncryptionKey.EncryptionKey()"
|
|
name: "EncryptionKey()"
|
|
nameWithType: "EncryptionKey.EncryptionKey()"
|
|
syntax: "public EncryptionKey()"
|
|
methods:
|
|
- uid: "com.azure.search.models.EncryptionKey.getAccessCredentials()"
|
|
fullName: "com.azure.search.models.EncryptionKey.getAccessCredentials()"
|
|
name: "getAccessCredentials()"
|
|
nameWithType: "EncryptionKey.getAccessCredentials()"
|
|
summary: "Get the access<wbr>Credentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault."
|
|
syntax: "public AzureActiveDirectoryApplicationCredentials getAccessCredentials()"
|
|
desc: "Get the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead."
|
|
returns:
|
|
description: "the accessCredentials value."
|
|
type: "<xref href=\"com.azure.search.models.AzureActiveDirectoryApplicationCredentials?alt=com.azure.search.models.AzureActiveDirectoryApplicationCredentials&text=AzureActiveDirectoryApplicationCredentials\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.EncryptionKey.getKeyVaultKeyName()"
|
|
fullName: "com.azure.search.models.EncryptionKey.getKeyVaultKeyName()"
|
|
name: "getKeyVaultKeyName()"
|
|
nameWithType: "EncryptionKey.getKeyVaultKeyName()"
|
|
summary: "Get the key<wbr>Vault<wbr>Key<wbr>Name property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
syntax: "public String getKeyVaultKeyName()"
|
|
desc: "Get the keyVaultKeyName property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
returns:
|
|
description: "the keyVaultKeyName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.models.EncryptionKey.getKeyVaultKeyVersion()"
|
|
fullName: "com.azure.search.models.EncryptionKey.getKeyVaultKeyVersion()"
|
|
name: "getKeyVaultKeyVersion()"
|
|
nameWithType: "EncryptionKey.getKeyVaultKeyVersion()"
|
|
summary: "Get the key<wbr>Vault<wbr>Key<wbr>Version property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
syntax: "public String getKeyVaultKeyVersion()"
|
|
desc: "Get the keyVaultKeyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
returns:
|
|
description: "the keyVaultKeyVersion value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.models.EncryptionKey.getKeyVaultUri()"
|
|
fullName: "com.azure.search.models.EncryptionKey.getKeyVaultUri()"
|
|
name: "getKeyVaultUri()"
|
|
nameWithType: "EncryptionKey.getKeyVaultUri()"
|
|
summary: "Get the key<wbr>Vault<wbr>Uri property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest."
|
|
syntax: "public String getKeyVaultUri()"
|
|
desc: "Get the keyVaultUri property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net."
|
|
returns:
|
|
description: "the keyVaultUri value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.models.EncryptionKey.setAccessCredentials(com.azure.search.models.AzureActiveDirectoryApplicationCredentials)"
|
|
fullName: "com.azure.search.models.EncryptionKey.setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)"
|
|
name: "setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)"
|
|
nameWithType: "EncryptionKey.setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)"
|
|
summary: "Set the access<wbr>Credentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault."
|
|
parameters:
|
|
- description: "the accessCredentials value to set."
|
|
name: "accessCredentials"
|
|
type: "<xref href=\"com.azure.search.models.AzureActiveDirectoryApplicationCredentials?alt=com.azure.search.models.AzureActiveDirectoryApplicationCredentials&text=AzureActiveDirectoryApplicationCredentials\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EncryptionKey setAccessCredentials(AzureActiveDirectoryApplicationCredentials accessCredentials)"
|
|
desc: "Set the accessCredentials property: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead."
|
|
returns:
|
|
description: "the EncryptionKey object itself."
|
|
type: "<xref href=\"com.azure.search.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.EncryptionKey.setKeyVaultKeyName(java.lang.String)"
|
|
fullName: "com.azure.search.models.EncryptionKey.setKeyVaultKeyName(String keyVaultKeyName)"
|
|
name: "setKeyVaultKeyName(String keyVaultKeyName)"
|
|
nameWithType: "EncryptionKey.setKeyVaultKeyName(String keyVaultKeyName)"
|
|
summary: "Set the key<wbr>Vault<wbr>Key<wbr>Name property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
parameters:
|
|
- description: "the keyVaultKeyName value to set."
|
|
name: "keyVaultKeyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public EncryptionKey setKeyVaultKeyName(String keyVaultKeyName)"
|
|
desc: "Set the keyVaultKeyName property: The name of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
returns:
|
|
description: "the EncryptionKey object itself."
|
|
type: "<xref href=\"com.azure.search.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.EncryptionKey.setKeyVaultKeyVersion(java.lang.String)"
|
|
fullName: "com.azure.search.models.EncryptionKey.setKeyVaultKeyVersion(String keyVaultKeyVersion)"
|
|
name: "setKeyVaultKeyVersion(String keyVaultKeyVersion)"
|
|
nameWithType: "EncryptionKey.setKeyVaultKeyVersion(String keyVaultKeyVersion)"
|
|
summary: "Set the key<wbr>Vault<wbr>Key<wbr>Version property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
parameters:
|
|
- description: "the keyVaultKeyVersion value to set."
|
|
name: "keyVaultKeyVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public EncryptionKey setKeyVaultKeyVersion(String keyVaultKeyVersion)"
|
|
desc: "Set the keyVaultKeyVersion property: The version of your Azure Key Vault key to be used to encrypt your data at rest."
|
|
returns:
|
|
description: "the EncryptionKey object itself."
|
|
type: "<xref href=\"com.azure.search.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.EncryptionKey.setKeyVaultUri(java.lang.String)"
|
|
fullName: "com.azure.search.models.EncryptionKey.setKeyVaultUri(String keyVaultUri)"
|
|
name: "setKeyVaultUri(String keyVaultUri)"
|
|
nameWithType: "EncryptionKey.setKeyVaultUri(String keyVaultUri)"
|
|
summary: "Set the key<wbr>Vault<wbr>Uri property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest."
|
|
parameters:
|
|
- description: "the keyVaultUri value to set."
|
|
name: "keyVaultUri"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public EncryptionKey setKeyVaultUri(String keyVaultUri)"
|
|
desc: "Set the keyVaultUri property: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net."
|
|
returns:
|
|
description: "the EncryptionKey object itself."
|
|
type: "<xref href=\"com.azure.search.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps."
|
|
metadata: {}
|
|
package: "com.azure.search.models"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|