Package-level declarations

Types

Link copied to clipboard
data class AccessPolicyEntry(val applicationId: String? = null, val objectId: String, val permissions: Permissions, val tenantId: String)

An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.

Link copied to clipboard
data class AccessPolicyEntryResponse(val applicationId: String? = null, val objectId: String, val permissions: PermissionsResponse, val tenantId: String)

An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.

Link copied to clipboard
data class ActionResponse(val type: String? = null)
Link copied to clipboard
data class GetKeyResult(val attributes: KeyAttributesResponse? = null, val azureApiVersion: String, val curveName: String? = null, val id: String, val keyOps: List<String>? = null, val keySize: Int? = null, val keyUri: String, val keyUriWithVersion: String, val kty: String? = null, val location: String, val name: String, val releasePolicy: KeyReleasePolicyResponse? = null, val rotationPolicy: RotationPolicyResponse? = null, val tags: Map<String, String>, val type: String)

The key resource.

Link copied to clipboard
data class GetManagedHsmResult(val azureApiVersion: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val properties: ManagedHsmPropertiesResponse, val sku: ManagedHsmSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Resource information with extended details.

Link copied to clipboard
data class GetMHSMPrivateEndpointConnectionResult(val azureApiVersion: String, val etag: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val privateEndpoint: MHSMPrivateEndpointResponse? = null, val privateLinkServiceConnectionState: MHSMPrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val sku: ManagedHsmSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Private endpoint connection resource.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val etag: String? = null, val id: String, val location: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val tags: Map<String, String>, val type: String)

Private endpoint connection resource.

Link copied to clipboard
data class GetSecretResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SecretPropertiesResponse, val tags: Map<String, String>, val type: String)

Resource information with extended details.

Link copied to clipboard
data class GetVaultResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: VaultPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Resource information with extended details.

Link copied to clipboard
data class IPRuleResponse(val value: String)

A rule governing the accessibility of a vault from a specific ip address or ip range.

Link copied to clipboard
data class KeyAttributesResponse(val created: Double, val enabled: Boolean? = null, val expires: Double? = null, val exportable: Boolean? = null, val notBefore: Double? = null, val recoveryLevel: String, val updated: Double)

The object attributes managed by the Azure Key Vault service.

Link copied to clipboard
data class KeyReleasePolicyResponse(val contentType: String? = null, val data: String? = null)
Link copied to clipboard
data class KeyRotationPolicyAttributesResponse(val created: Double, val expiryTime: String? = null, val updated: Double)
Link copied to clipboard
data class LifetimeActionResponse(val action: ActionResponse? = null, val trigger: TriggerResponse? = null)
Link copied to clipboard
data class ManagedHsmPropertiesResponse(val enablePurgeProtection: Boolean? = null, val enableSoftDelete: Boolean? = null, val hsmUri: String, val initialAdminObjectIds: List<String>? = null, val networkAcls: MHSMNetworkRuleSetResponse? = null, val privateEndpointConnections: List<MHSMPrivateEndpointConnectionItemResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val regions: List<MHSMGeoReplicatedRegionResponse>? = null, val scheduledPurgeDate: String, val securityDomainProperties: ManagedHSMSecurityDomainPropertiesResponse, val softDeleteRetentionInDays: Int? = null, val statusMessage: String, val tenantId: String? = null)

Properties of the managed HSM Pool

data class ManagedHSMSecurityDomainPropertiesResponse(val activationStatus: String, val activationStatusMessage: String)

The security domain properties of the managed hsm.

Link copied to clipboard
data class ManagedHsmSkuResponse(val family: String, val name: String)

SKU details

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class MHSMGeoReplicatedRegionResponse(val isPrimary: Boolean? = null, val name: String? = null, val provisioningState: String)

A region that this managed HSM Pool has been extended to.

Link copied to clipboard
data class MHSMIPRuleResponse(val value: String)

A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.

Link copied to clipboard
data class MHSMNetworkRuleSetResponse(val bypass: String? = null, val defaultAction: String? = null, val ipRules: List<MHSMIPRuleResponse>? = null, val virtualNetworkRules: List<MHSMVirtualNetworkRuleResponse>? = null)

A set of rules governing the network accessibility of a managed hsm pool.

data class MHSMPrivateEndpointConnectionItemResponse(val etag: String? = null, val id: String? = null, val privateEndpoint: MHSMPrivateEndpointResponse? = null, val privateLinkServiceConnectionState: MHSMPrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String)

Private endpoint connection item.

Link copied to clipboard

Private endpoint object properties.

data class MHSMPrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

An object that represents the approval state of the private link connection.

Link copied to clipboard

A rule governing the accessibility of a managed hsm pool from a specific virtual network.

Link copied to clipboard
data class NetworkRuleSetResponse(val bypass: String? = null, val defaultAction: String? = null, val ipRules: List<IPRuleResponse>? = null, val virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null)

A set of rules governing the network accessibility of a vault.

Link copied to clipboard
data class Permissions(val certificates: List<Either<String, CertificatePermissions>>? = null, val keys: List<Either<String, KeyPermissions>>? = null, val secrets: List<Either<String, SecretPermissions>>? = null, val storage: List<Either<String, StoragePermissions>>? = null)

Permissions the identity has for keys, secrets, certificates and storage.

Link copied to clipboard
data class PermissionsResponse(val certificates: List<String>? = null, val keys: List<String>? = null, val secrets: List<String>? = null, val storage: List<String>? = null)

Permissions the identity has for keys, secrets, certificates and storage.

Link copied to clipboard
data class PrivateEndpointConnectionItemResponse(val etag: String? = null, val id: String? = null, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String)

Private endpoint connection item.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

Private endpoint object properties.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

An object that represents the approval state of the private link connection.

Link copied to clipboard
data class RotationPolicyResponse(val attributes: KeyRotationPolicyAttributesResponse? = null, val lifetimeActions: List<LifetimeActionResponse>? = null)
Link copied to clipboard
data class SecretAttributesResponse(val created: Int, val enabled: Boolean? = null, val expires: Int? = null, val notBefore: Int? = null, val updated: Int)

The secret management attributes.

Link copied to clipboard
data class SecretPropertiesResponse(val attributes: SecretAttributesResponse? = null, val contentType: String? = null, val secretUri: String, val secretUriWithVersion: String, val value: String? = null)

Properties of the secret

Link copied to clipboard
data class SkuResponse(val family: String, val name: String)

SKU details

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the key vault resource.

Link copied to clipboard
data class TriggerResponse(val timeAfterCreate: String? = null, val timeBeforeExpiry: String? = null)
Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VaultPropertiesResponse(val accessPolicies: List<AccessPolicyEntryResponse>? = null, val enablePurgeProtection: Boolean? = null, val enableRbacAuthorization: Boolean? = null, val enableSoftDelete: Boolean? = null, val enabledForDeployment: Boolean? = null, val enabledForDiskEncryption: Boolean? = null, val enabledForTemplateDeployment: Boolean? = null, val hsmPoolResourceId: String, val networkAcls: NetworkRuleSetResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionItemResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val sku: SkuResponse, val softDeleteRetentionInDays: Int? = null, val tenantId: String, val vaultUri: String)

Properties of the vault

Link copied to clipboard
data class VirtualNetworkRuleResponse(val id: String, val ignoreMissingVnetServiceEndpoint: Boolean? = null)

A rule governing the accessibility of a vault from a specific virtual network.