pulumi-azure-native-kotlin/com.pulumi.azurenative.storage.kotlin.outputs

Package-level declarations

Types

data class ActiveDirectoryPropertiesResponse(val azureStorageSid: String, val domainGuid: String, val domainName: String, val domainSid: String, val forestName: String, val netBiosDomainName: String)

Settings properties for Active Directory (AD).

AzureFilesIdentityBasedAuthenticationResponse

data class AzureFilesIdentityBasedAuthenticationResponse(val activeDirectoryProperties: ActiveDirectoryPropertiesResponse? = null, val directoryServiceOptions: String)

Settings for Azure Files identity based authentication.

BlobInventoryPolicyDefinitionResponse

data class BlobInventoryPolicyDefinitionResponse(val filters: BlobInventoryPolicyFilterResponse)

An object that defines the blob inventory rule. Each definition consists of a set of filters.

BlobInventoryPolicyFilterResponse

data class BlobInventoryPolicyFilterResponse(val blobTypes: List<String>, val includeBlobVersions: Boolean? = null, val includeSnapshots: Boolean? = null, val prefixMatch: List<String>? = null)

An object that defines the blob inventory rule filter conditions.

BlobInventoryPolicyRuleResponse

data class BlobInventoryPolicyRuleResponse(val definition: BlobInventoryPolicyDefinitionResponse, val enabled: Boolean, val name: String)

An object that wraps the blob inventory rule. Each rule is uniquely defined by name.

BlobInventoryPolicySchemaResponse

data class BlobInventoryPolicySchemaResponse(val destination: String, val enabled: Boolean, val rules: List<BlobInventoryPolicyRuleResponse>, val type: String)

The storage account blob inventory policy rules.

BlobRestoreParametersResponse

data class BlobRestoreParametersResponse(val blobRanges: List<BlobRestoreRangeResponse>, val timeToRestore: String)

Blob restore parameters

BlobRestoreRangeResponse

data class BlobRestoreRangeResponse(val endRange: String, val startRange: String)

Blob range

BlobRestoreStatusResponse

data class BlobRestoreStatusResponse(val failureReason: String, val parameters: BlobRestoreParametersResponse, val restoreId: String, val status: String)

Blob restore status.

ChangeFeedResponse

data class ChangeFeedResponse(val enabled: Boolean? = null, val retentionInDays: Int? = null)

The blob service properties for change feed events.

CorsRuleResponse

data class CorsRuleResponse(val allowedHeaders: List<String>, val allowedMethods: List<String>, val allowedOrigins: List<String>, val exposedHeaders: List<String>, val maxAgeInSeconds: Int)

Specifies a CORS rule for the Blob service.

CorsRulesResponse

data class CorsRulesResponse(val corsRules: List<CorsRuleResponse>? = null)

Sets the CORS rules. You can include up to five CorsRule elements in the request.

CustomDomainResponse

data class CustomDomainResponse(val name: String, val useSubDomainName: Boolean? = null)

The custom domain assigned to this storage account. This can be set via Update.

DateAfterCreationResponse

data class DateAfterCreationResponse(val daysAfterCreationGreaterThan: Double)

Object to define the number of days after creation.

DateAfterModificationResponse

data class DateAfterModificationResponse(val daysAfterLastAccessTimeGreaterThan: Double? = null, val daysAfterModificationGreaterThan: Double? = null)

Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.

DeleteRetentionPolicyResponse

data class DeleteRetentionPolicyResponse(val days: Int? = null, val enabled: Boolean? = null)

The service properties for soft delete.

EncryptionIdentityResponse

data class EncryptionIdentityResponse(val encryptionUserAssignedIdentity: String? = null)

Encryption identity for the storage account.

EncryptionResponse

data class EncryptionResponse(val encryptionIdentity: EncryptionIdentityResponse? = null, val keySource: String, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val requireInfrastructureEncryption: Boolean? = null, val services: EncryptionServicesResponse? = null)

The encryption settings on the storage account.

EncryptionScopeKeyVaultPropertiesResponse

data class EncryptionScopeKeyVaultPropertiesResponse(val currentVersionedKeyIdentifier: String, val keyUri: String? = null, val lastKeyRotationTimestamp: String)

The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.

EncryptionServiceResponse

data class EncryptionServiceResponse(val enabled: Boolean? = null, val keyType: String? = null, val lastEnabledTime: String)

A service that allows server-side encryption to be used.

EncryptionServicesResponse

data class EncryptionServicesResponse(val blob: EncryptionServiceResponse? = null, val file: EncryptionServiceResponse? = null, val queue: EncryptionServiceResponse? = null, val table: EncryptionServiceResponse? = null)

A list of services that support encryption.

EndpointsResponse

data class EndpointsResponse(val blob: String, val dfs: String, val file: String, val internetEndpoints: StorageAccountInternetEndpointsResponse? = null, val microsoftEndpoints: StorageAccountMicrosoftEndpointsResponse? = null, val queue: String, val table: String, val web: String)

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object.

ExtendedLocationResponse

data class ExtendedLocationResponse(val name: String? = null, val type: String? = null)

The complex type of the extended location.

GeoReplicationStatsResponse

data class GeoReplicationStatsResponse(val canFailover: Boolean, val lastSyncTime: String, val status: String)

Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account.

GetBlobContainerImmutabilityPolicyResult

data class GetBlobContainerImmutabilityPolicyResult(val allowProtectedAppendWrites: Boolean? = null, val etag: String, val id: String, val immutabilityPeriodSinceCreationInDays: Int? = null, val name: String, val state: String, val type: String)

The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag.

GetBlobContainerResult

data class GetBlobContainerResult(val defaultEncryptionScope: String? = null, val deleted: Boolean, val deletedTime: String, val denyEncryptionScopeOverride: Boolean? = null, val etag: String, val hasImmutabilityPolicy: Boolean, val hasLegalHold: Boolean, val id: String, val immutabilityPolicy: ImmutabilityPolicyPropertiesResponse, val lastModifiedTime: String, val leaseDuration: String, val leaseState: String, val leaseStatus: String, val legalHold: LegalHoldPropertiesResponse, val metadata: Map<String, String>? = null, val name: String, val publicAccess: String? = null, val remainingRetentionDays: Int, val type: String, val version: String)

Properties of the blob container, including Id, resource name, resource type, Etag.

GetBlobInventoryPolicyResult

data class GetBlobInventoryPolicyResult(val id: String, val lastModifiedTime: String, val name: String, val policy: BlobInventoryPolicySchemaResponse, val systemData: SystemDataResponse, val type: String)

The storage account blob inventory policy.

GetBlobServicePropertiesResult

data class GetBlobServicePropertiesResult(val automaticSnapshotPolicyEnabled: Boolean? = null, val changeFeed: ChangeFeedResponse? = null, val containerDeleteRetentionPolicy: DeleteRetentionPolicyResponse? = null, val cors: CorsRulesResponse? = null, val defaultServiceVersion: String? = null, val deleteRetentionPolicy: DeleteRetentionPolicyResponse? = null, val id: String, val isVersioningEnabled: Boolean? = null, val lastAccessTimeTrackingPolicy: LastAccessTimeTrackingPolicyResponse? = null, val name: String, val restorePolicy: RestorePolicyPropertiesResponse? = null, val sku: SkuResponse, val type: String)

The properties of a storage account’s Blob service.

GetEncryptionScopeResult

data class GetEncryptionScopeResult(val creationTime: String, val id: String, val keyVaultProperties: EncryptionScopeKeyVaultPropertiesResponse? = null, val lastModifiedTime: String, val name: String, val requireInfrastructureEncryption: Boolean? = null, val source: String? = null, val state: String? = null, val type: String)

The Encryption Scope resource.

GetFileServicePropertiesResult

data class GetFileServicePropertiesResult(val cors: CorsRulesResponse? = null, val id: String, val name: String, val protocolSettings: ProtocolSettingsResponse? = null, val shareDeleteRetentionPolicy: DeleteRetentionPolicyResponse? = null, val sku: SkuResponse, val type: String)

The properties of File services in storage account.

GetFileShareResult

data class GetFileShareResult(val accessTier: String? = null, val accessTierChangeTime: String, val accessTierStatus: String, val deleted: Boolean, val deletedTime: String, val enabledProtocols: String? = null, val etag: String, val id: String, val lastModifiedTime: String, val metadata: Map<String, String>? = null, val name: String, val remainingRetentionDays: Int, val rootSquash: String? = null, val shareQuota: Int? = null, val shareUsageBytes: Double, val snapshotTime: String, val type: String, val version: String)

Properties of the file share, including Id, resource name, resource type, Etag.

GetLocalUserResult

data class GetLocalUserResult(val hasSharedKey: Boolean? = null, val hasSshKey: Boolean? = null, val hasSshPassword: Boolean? = null, val homeDirectory: String? = null, val id: String, val name: String, val permissionScopes: List<PermissionScopeResponse>? = null, val sid: String, val sshAuthorizedKeys: List<SshPublicKeyResponse>? = null, val systemData: SystemDataResponse, val type: String)

The local user associated with the storage accounts.

GetManagementPolicyResult

data class GetManagementPolicyResult(val id: String, val lastModifiedTime: String, val name: String, val policy: ManagementPolicySchemaResponse, val type: String)

The Get Storage Account ManagementPolicies operation response.

GetObjectReplicationPolicyResult

data class GetObjectReplicationPolicyResult(val destinationAccount: String, val enabledTime: String, val id: String, val name: String, val policyId: String, val rules: List<ObjectReplicationPolicyRuleResponse>? = null, val sourceAccount: String, val type: String)

The replication policy between two storage accounts. Multiple rules can be defined in one policy.

GetPrivateEndpointConnectionResult

data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

GetQueueResult

data class GetQueueResult(val approximateMessageCount: Int, val id: String, val metadata: Map<String, String>? = null, val name: String, val type: String)

GetQueueServicePropertiesResult

data class GetQueueServicePropertiesResult(val cors: CorsRulesResponse? = null, val id: String, val name: String, val type: String)

The properties of a storage account’s Queue service.

GetStorageAccountResult

data class GetStorageAccountResult(val accessTier: String, val allowBlobPublicAccess: Boolean? = null, val allowSharedKeyAccess: Boolean? = null, val azureFilesIdentityBasedAuthentication: AzureFilesIdentityBasedAuthenticationResponse? = null, val blobRestoreStatus: BlobRestoreStatusResponse, val creationTime: String, val customDomain: CustomDomainResponse, val enableHttpsTrafficOnly: Boolean? = null, val enableNfsV3: Boolean? = null, val encryption: EncryptionResponse, val extendedLocation: ExtendedLocationResponse? = null, val failoverInProgress: Boolean, val geoReplicationStats: GeoReplicationStatsResponse, val id: String, val identity: IdentityResponse? = null, val isHnsEnabled: Boolean? = null, val keyCreationTime: KeyCreationTimeResponse, val keyPolicy: KeyPolicyResponse, val kind: String, val largeFileSharesState: String? = null, val lastGeoFailoverTime: String, val location: String, val minimumTlsVersion: String? = null, val name: String, val networkRuleSet: NetworkRuleSetResponse, val primaryEndpoints: EndpointsResponse, val primaryLocation: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val routingPreference: RoutingPreferenceResponse? = null, val sasPolicy: SasPolicyResponse, val secondaryEndpoints: EndpointsResponse, val secondaryLocation: String, val sku: SkuResponse, val statusOfPrimary: String, val statusOfSecondary: String, val tags: Map<String, String>? = null, val type: String)

The storage account.

GetTableResult

data class GetTableResult(val id: String, val name: String, val tableName: String, val type: String)

Properties of the table, including Id, resource name, resource type.

GetTableServicePropertiesResult

data class GetTableServicePropertiesResult(val cors: CorsRulesResponse? = null, val id: String, val name: String, val type: String)

The properties of a storage account’s Table service.

IdentityResponse

data class IdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Identity for the resource.

ImmutabilityPolicyPropertiesResponse

data class ImmutabilityPolicyPropertiesResponse(val allowProtectedAppendWrites: Boolean? = null, val etag: String, val immutabilityPeriodSinceCreationInDays: Int? = null, val state: String, val updateHistory: List<UpdateHistoryPropertyResponse>)

The properties of an ImmutabilityPolicy of a blob container.

IPRuleResponse

data class IPRuleResponse(val action: String? = null, val iPAddressOrRange: String)

IP rule with specific IP or IP range in CIDR format.

KeyCreationTimeResponse

data class KeyCreationTimeResponse(val key1: String? = null, val key2: String? = null)

Storage account keys creation time.

KeyPolicyResponse

data class KeyPolicyResponse(val keyExpirationPeriodInDays: Int)

KeyPolicy assigned to the storage account.

KeyVaultPropertiesResponse

data class KeyVaultPropertiesResponse(val currentVersionedKeyIdentifier: String, val keyName: String? = null, val keyVaultUri: String? = null, val keyVersion: String? = null, val lastKeyRotationTimestamp: String)

Properties of key vault.

LastAccessTimeTrackingPolicyResponse

data class LastAccessTimeTrackingPolicyResponse(val blobType: List<String>? = null, val enable: Boolean, val name: String? = null, val trackingGranularityInDays: Int? = null)

The blob service properties for Last access time based tracking policy.

LegalHoldPropertiesResponse

data class LegalHoldPropertiesResponse(val hasLegalHold: Boolean, val tags: List<TagPropertyResponse>? = null)

The LegalHold property of a blob container.

ListLocalUserKeysResult

data class ListLocalUserKeysResult(val sharedKey: String, val sshAuthorizedKeys: List<SshPublicKeyResponse>? = null)

The Storage Account Local User keys.

ListStorageAccountKeysResult

data class ListStorageAccountKeysResult(val keys: List<StorageAccountKeyResponse>)

The response from the ListKeys operation.

ListStorageAccountSASResult

data class ListStorageAccountSASResult(val accountSasToken: String)

The List SAS credentials operation response.

ListStorageAccountServiceSASResult

data class ListStorageAccountServiceSASResult(val serviceSasToken: String)

The List service SAS credentials operation response.

ManagementPolicyActionResponse

data class ManagementPolicyActionResponse(val baseBlob: ManagementPolicyBaseBlobResponse? = null, val snapshot: ManagementPolicySnapShotResponse? = null, val version: ManagementPolicyVersionResponse? = null)

Actions are applied to the filtered blobs when the execution condition is met.

ManagementPolicyBaseBlobResponse

data class ManagementPolicyBaseBlobResponse(val delete: DateAfterModificationResponse? = null, val enableAutoTierToHotFromCool: Boolean? = null, val tierToArchive: DateAfterModificationResponse? = null, val tierToCool: DateAfterModificationResponse? = null)

Management policy action for base blob.

ManagementPolicyDefinitionResponse

data class ManagementPolicyDefinitionResponse(val actions: ManagementPolicyActionResponse, val filters: ManagementPolicyFilterResponse? = null)

An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.

ManagementPolicyFilterResponse

data class ManagementPolicyFilterResponse(val blobIndexMatch: List<TagFilterResponse>? = null, val blobTypes: List<String>, val prefixMatch: List<String>? = null)

Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters.

ManagementPolicyRuleResponse

data class ManagementPolicyRuleResponse(val definition: ManagementPolicyDefinitionResponse, val enabled: Boolean? = null, val name: String, val type: String)

An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.

ManagementPolicySchemaResponse

data class ManagementPolicySchemaResponse(val rules: List<ManagementPolicyRuleResponse>)

The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.

ManagementPolicySnapShotResponse

data class ManagementPolicySnapShotResponse(val delete: DateAfterCreationResponse? = null, val tierToArchive: DateAfterCreationResponse? = null, val tierToCool: DateAfterCreationResponse? = null)

Management policy action for snapshot.

ManagementPolicyVersionResponse

data class ManagementPolicyVersionResponse(val delete: DateAfterCreationResponse? = null, val tierToArchive: DateAfterCreationResponse? = null, val tierToCool: DateAfterCreationResponse? = null)

Management policy action for blob version.

MultichannelResponse

data class MultichannelResponse(val enabled: Boolean? = null)

Multichannel setting. Applies to Premium FileStorage only.

NetworkRuleSetResponse

data class NetworkRuleSetResponse(val bypass: String? = null, val defaultAction: String, val ipRules: List<IPRuleResponse>? = null, val resourceAccessRules: List<ResourceAccessRuleResponse>? = null, val virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null)

Network rule set

ObjectReplicationPolicyFilterResponse

data class ObjectReplicationPolicyFilterResponse(val minCreationTime: String? = null, val prefixMatch: List<String>? = null)

Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters.

ObjectReplicationPolicyRuleResponse

data class ObjectReplicationPolicyRuleResponse(val destinationContainer: String, val filters: ObjectReplicationPolicyFilterResponse? = null, val ruleId: String? = null, val sourceContainer: String)

The replication policy rule between two containers.

PermissionScopeResponse

data class PermissionScopeResponse(val permissions: String, val resourceName: String, val service: String)

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

The Private Endpoint Connection resource.

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

PrivateLinkServiceConnectionStateResponse

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

A collection of information about the state of the connection between service consumer and provider.

ProtocolSettingsResponse

data class ProtocolSettingsResponse(val smb: SmbSettingResponse? = null)

Protocol settings for file service

ResourceAccessRuleResponse

data class ResourceAccessRuleResponse(val resourceId: String? = null, val tenantId: String? = null)

Resource Access Rule.

RestorePolicyPropertiesResponse

data class RestorePolicyPropertiesResponse(val days: Int? = null, val enabled: Boolean, val lastEnabledTime: String, val minRestoreTime: String)

The blob service properties for blob restore policy

RoutingPreferenceResponse

data class RoutingPreferenceResponse(val publishInternetEndpoints: Boolean? = null, val publishMicrosoftEndpoints: Boolean? = null, val routingChoice: String? = null)

Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing

SasPolicyResponse

data class SasPolicyResponse(val expirationAction: String, val sasExpirationPeriod: String)

SasPolicy assigned to the storage account.

SkuResponse

data class SkuResponse(val name: String, val tier: String)

The SKU of the storage account.

SmbSettingResponse

data class SmbSettingResponse(val authenticationMethods: String? = null, val channelEncryption: String? = null, val kerberosTicketEncryption: String? = null, val multichannel: MultichannelResponse? = null, val versions: String? = null)

Setting for SMB protocol

SshPublicKeyResponse

data class SshPublicKeyResponse(val description: String? = null, val key: String? = null)

StorageAccountInternetEndpointsResponse

data class StorageAccountInternetEndpointsResponse(val blob: String, val dfs: String, val file: String, val web: String)

The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.

StorageAccountKeyResponse

data class StorageAccountKeyResponse(val creationTime: String, val keyName: String, val permissions: String, val value: String)

An access key for the storage account.

StorageAccountMicrosoftEndpointsResponse

data class StorageAccountMicrosoftEndpointsResponse(val blob: String, val dfs: String, val file: String, val queue: String, val table: String, val web: String)

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.

SystemDataResponse

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 resource.

TagFilterResponse

data class TagFilterResponse(val name: String, val op: String, val value: String)

Blob index tag based filtering for blob objects

TagPropertyResponse

data class TagPropertyResponse(val objectIdentifier: String, val tag: String, val tenantId: String, val timestamp: String, val upn: String)

A tag of the LegalHold of a blob container.

UpdateHistoryPropertyResponse

data class UpdateHistoryPropertyResponse(val immutabilityPeriodSinceCreationInDays: Int, val objectIdentifier: String, val tenantId: String, val timestamp: String, val update: String, val upn: String)

An update history of the ImmutabilityPolicy of a blob container.

UserAssignedIdentityResponse

data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

UserAssignedIdentity for the resource.

VirtualNetworkRuleResponse

data class VirtualNetworkRuleResponse(val action: String? = null, val state: String? = null, val virtualNetworkResourceId: String)

Virtual Network rule.