174 строки
14 KiB
YAML
174 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms"
|
|
name: "AzureKeyVaultKms"
|
|
nameWithType: "AzureKeyVaultKms"
|
|
summary: "Azure Key Vault key management service settings for the security profile."
|
|
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 **AzureKeyVaultKms**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.AzureKeyVaultKms()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.AzureKeyVaultKms()"
|
|
name: "AzureKeyVaultKms()"
|
|
nameWithType: "AzureKeyVaultKms.AzureKeyVaultKms()"
|
|
summary: "Creates an instance of Azure<wbr>Key<wbr>Vault<wbr>Kms class."
|
|
syntax: "public AzureKeyVaultKms()"
|
|
desc: "Creates an instance of AzureKeyVaultKms class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.enabled()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.enabled()"
|
|
name: "enabled()"
|
|
nameWithType: "AzureKeyVaultKms.enabled()"
|
|
summary: "Get the enabled property: Whether to enable Azure Key Vault key management service."
|
|
syntax: "public Boolean enabled()"
|
|
desc: "Get the enabled property: Whether to enable Azure Key Vault key management service. The default is false."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "AzureKeyVaultKms.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Azure<wbr>Key<wbr>Vault<wbr>Kms from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static AzureKeyVaultKms fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the AzureKeyVaultKms."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of AzureKeyVaultKms from the JsonReader."
|
|
returns:
|
|
description: "An instance of AzureKeyVaultKms if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyId()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyId()"
|
|
name: "keyId()"
|
|
nameWithType: "AzureKeyVaultKms.keyId()"
|
|
summary: "Get the key<wbr>Id property: Identifier of Azure Key Vault key."
|
|
syntax: "public String keyId()"
|
|
desc: "Get the keyId property: Identifier of Azure Key Vault key. See \\[key identifier format\\](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates\\#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
|
|
returns:
|
|
description: "the keyId value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyVaultNetworkAccess()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyVaultNetworkAccess()"
|
|
name: "keyVaultNetworkAccess()"
|
|
nameWithType: "AzureKeyVaultKms.keyVaultNetworkAccess()"
|
|
summary: "Get the key<wbr>Vault<wbr>Network<wbr>Access property: Network access of key vault."
|
|
syntax: "public KeyVaultNetworkAccessTypes keyVaultNetworkAccess()"
|
|
desc: "Get the keyVaultNetworkAccess property: Network access of key vault. The possible values are \\`Public\\` and \\`Private\\`. \\`Public\\` means the key vault allows public access from all networks. \\`Private\\` means the key vault disables public access and enables private link. The default value is \\`Public\\`."
|
|
returns:
|
|
description: "the keyVaultNetworkAccess value."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KeyVaultNetworkAccessTypes?alt=com.azure.resourcemanager.containerservice.models.KeyVaultNetworkAccessTypes&text=KeyVaultNetworkAccessTypes\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyVaultResourceId()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.keyVaultResourceId()"
|
|
name: "keyVaultResourceId()"
|
|
nameWithType: "AzureKeyVaultKms.keyVaultResourceId()"
|
|
summary: "Get the key<wbr>Vault<wbr>Resource<wbr>Id property: Resource ID of key vault."
|
|
syntax: "public String keyVaultResourceId()"
|
|
desc: "Get the keyVaultResourceId property: Resource ID of key vault. When keyVaultNetworkAccess is \\`Private\\`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is \\`Public\\`, leave the field empty."
|
|
returns:
|
|
description: "the keyVaultResourceId value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "AzureKeyVaultKms.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.validate()"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.validate()"
|
|
name: "validate()"
|
|
nameWithType: "AzureKeyVaultKms.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withEnabled(Boolean enabled)"
|
|
name: "withEnabled(Boolean enabled)"
|
|
nameWithType: "AzureKeyVaultKms.withEnabled(Boolean enabled)"
|
|
summary: "Set the enabled property: Whether to enable Azure Key Vault key management service."
|
|
parameters:
|
|
- description: "the enabled value to set."
|
|
name: "enabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public AzureKeyVaultKms withEnabled(Boolean enabled)"
|
|
desc: "Set the enabled property: Whether to enable Azure Key Vault key management service. The default is false."
|
|
returns:
|
|
description: "the AzureKeyVaultKms object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyId(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyId(String keyId)"
|
|
name: "withKeyId(String keyId)"
|
|
nameWithType: "AzureKeyVaultKms.withKeyId(String keyId)"
|
|
summary: "Set the key<wbr>Id property: Identifier of Azure Key Vault key."
|
|
parameters:
|
|
- description: "the keyId value to set."
|
|
name: "keyId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureKeyVaultKms withKeyId(String keyId)"
|
|
desc: "Set the keyId property: Identifier of Azure Key Vault key. See \\[key identifier format\\](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates\\#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
|
|
returns:
|
|
description: "the AzureKeyVaultKms object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyVaultNetworkAccess(com.azure.resourcemanager.containerservice.models.KeyVaultNetworkAccessTypes)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess)"
|
|
name: "withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess)"
|
|
nameWithType: "AzureKeyVaultKms.withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess)"
|
|
summary: "Set the key<wbr>Vault<wbr>Network<wbr>Access property: Network access of key vault."
|
|
parameters:
|
|
- description: "the keyVaultNetworkAccess value to set."
|
|
name: "keyVaultNetworkAccess"
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.KeyVaultNetworkAccessTypes?alt=com.azure.resourcemanager.containerservice.models.KeyVaultNetworkAccessTypes&text=KeyVaultNetworkAccessTypes\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AzureKeyVaultKms withKeyVaultNetworkAccess(KeyVaultNetworkAccessTypes keyVaultNetworkAccess)"
|
|
desc: "Set the keyVaultNetworkAccess property: Network access of key vault. The possible values are \\`Public\\` and \\`Private\\`. \\`Public\\` means the key vault allows public access from all networks. \\`Private\\` means the key vault disables public access and enables private link. The default value is \\`Public\\`."
|
|
returns:
|
|
description: "the AzureKeyVaultKms object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyVaultResourceId(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms.withKeyVaultResourceId(String keyVaultResourceId)"
|
|
name: "withKeyVaultResourceId(String keyVaultResourceId)"
|
|
nameWithType: "AzureKeyVaultKms.withKeyVaultResourceId(String keyVaultResourceId)"
|
|
summary: "Set the key<wbr>Vault<wbr>Resource<wbr>Id property: Resource ID of key vault."
|
|
parameters:
|
|
- description: "the keyVaultResourceId value to set."
|
|
name: "keyVaultResourceId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AzureKeyVaultKms withKeyVaultResourceId(String keyVaultResourceId)"
|
|
desc: "Set the keyVaultResourceId property: Resource ID of key vault. When keyVaultNetworkAccess is \\`Private\\`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is \\`Public\\`, leave the field empty."
|
|
returns:
|
|
description: "the AzureKeyVaultKms object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Azure Key Vault key management service settings for the security profile."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms?alt=com.azure.resourcemanager.containerservice.models.AzureKeyVaultKms&text=AzureKeyVaultKms\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.containerservice.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-containerservice:2.44.0
|